tracker

README

Tracker

An Open-Source monitoring events tracking solution.

About Tracker

Tracker is open-source alternative to Datadog events or Newrelic custom events. The solution is composed of an api and a cli that enable the creation and retrieval of events in a Mongo or FeretDB database.

The idea behind this solution is to provide a simple way of keeping track of everything that happens on your platform, especially in a world of distributed services. Track the start and end of a deployment incident or the opening of an incident.

Each time an event is created, we create a log in json format, which enables tracker to be coupled with a logging solution such as Opensearch or Loki to correlate with logs and metrics.

Features

• Grpc Server
• Rest Server
• Option to start server
• Linked event in attributes
• Link a pull_request to an event
• Calculates the time between two linked events
• Cli to create and search event
• Lock deployment endpoint
• Add to cli lock and unlock function
• Config file for cli
• function search event of the day on cli
• Github Action to add event in CD pipeline
• Gitlab example to add event in CD pipeline

Getting Started 🚀

Requirements

• golang >= 1.21
• buf

Build

To compile tracker run this command, output a binnary in bin/event

make build

Update Protobuf Files

To updates protobuf files :

make generate

Test

To run test:

make test

Documentations

Events

Locks

Contributing

Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.

help wanted issues:

• Tracker