spcheema / loggy Goto Github PK

Related:

💻 LOGGY Client

📡 LOGGY NodeJS Adapter

🔥 Flexible

• Group events by services
• Easy-to-use adapter
• Custom adapters for any platform and language
• Customizable
• Can be self-hosted

🔥 Extensive Event Details

• Platform information
• Detailed evolution
• Stacktrace
• Code Snippets
• Logs
• Metrics
• Individual badges
• Adapter information

🔥 Aggregated events

• Live updates
• Same events are aggregated
• Event count
• Evolution preview

🔥 User management

• Invite and remove users from your organization

🔥 Highly scalable infrastructure

• Containerized backend
• Simple to deploy and scale

Running the LOGGY Docker image is the easiest way to get started. All you need is Docker and a MongoDB instance. You can install MongoDB locally, run it as a separate container or use a remote instance provided by services like mLab or Atlas.

docker run \
--env PORT=2800 \
--env SECRET=secret \
--env MONGO_URI=mongodb://admin:[email protected]:63108/loggy-test\?retryWrites=false \
--env MONGO_DB_NAME=loggy-test \
--env IS_SELFHOSTED=true \
-p 2800:2800 \
-it \
jz222/loggy:0.1.0

Clone the repository and install dependencies with go get. After adding an .env file that corresponds to the .example.env file, you can start the server with go run main.go.

To build a Docker image run the script build.dev.sh. It will create a local Docker image called loggy that can be run with the Docker command shown above.

Use the NodeJS adapter to register errors or build your own. To register an error, send a POST request to /logging/error with a JSON body like shown below.

{
	"ticket": "2ATNP1AD70",
	"message": "test is not a function",
	"path": "/User/example/server/src/server/server.js",
	"line": 15,
	"stacktrace": "the error stack trace",
	"badges": {
		"cluster": "test"
	},
	"type": "exception",
	"metrics": {
		"platform": "linux"
	},
	"logs": [
		{
			"type": "info",
			"log": "process started",
			"timestamp": 1585689440
		}
	],
	"snippet": {
		"10": "        cluster: 'EU',",
        	"11": "        serviceID: '20010-A'",
        	"12": "    }",
        	"13": "});",
        	"14": "",
        	"15": "test();",
        	"16": "",
        	"17": "// Routes",
        	"18": "const routes = require('../routes');",
        	"19": "",
        	"20": "// Configs"
	},
	"timestamp": 1585689898,
	"adapter": {
		"name": "loggy-adapter-nodejs",
		"type": "nodejs",
		"version": "v0.1.0"
	}
}

Please notice that timestamps have to be UTC timestamps in seconds.