1.0.8 • Published 2 years ago

logmyapp v1.0.8

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

Logmyapp logging

Logmyapp was built with simplicity in mind for developers. There are many things you can do with logmyapp such as logging when data goes through fine or when those errors show up unexpected.

Documentation

Steps to use Logmyapp

Head over to logmyapp choose login or sign up. After that, you will taken to a dashboard.

Once on the dashboard click new project in the top right corner in the dropdown menu.

Enter in the neccessary information the form. After that, you will get your API key.

After this you are ready to start using our npm package for monitoring

How to use this package

First install the package

  npm i logmyapp

After installing include this in the component or file you want to use logmyapp in.

import { log } from 'logymapp'

After importing the package use it like below in all or just specific areas.

const myFunction = () => {
    // your function that does an api call to your backend
    axios
        .get('http://exampleurltogetdatafrom.com')
        .then((response) => {
            log(response.status, 'success', APIKEY)
        })
        .catch((error) => {
            log(error.message, 'error', APIKEY)
        })
        .finally((finalResponse) => {
            log(finalResponse, 'finally', APIKEY)
        })
}

useEffect(() => {
    myFunction()
},[])

You can use all or just 1 of the above. Our platform doesn't require all 3 to function properly. The only thing is for better logging/monitoring you may want to include atleast .then and .catch

API Reference for npm package

Log an action

  log(message, type, apikey)
ParameterTypeDescription
messagestringRequired. The message to display in monitoring
typestringRequired. Possible params are (error, success, finally)
apikeystringRequired. Your API key obtained from here