daystram/audit repository overview

⁠Audit

Audit is a service monitoring and incident management service.

⁠Features

• WIP: Service availability/uptime monitoring
• WIP: Response time logging
• WIP: HTTP service tracking
• WIP: TCP/UDP service tracking
• WIP: Incident log management
• WIP: Multi-region distributed tracker agents

⁠Services

The application comes in two parts:

⁠Develop

⁠audit-be

audit-be uses Go Modules⁠ module/dependency manager, hence at least Go 1.11 is required. To ease development, comstrek/air⁠ is used to live-reload the application. Install the tool as documented.

To begin developing, simply enter the sub-directory and run the development server:

$ cd audit-be
$ go mod tidy
$ air

⁠audit-fe

Populate .env.development with the required credentials.

To begin developing, simply enter the sub-directory and run the development server:

$ cd audit-fe
$ yarn
$ yarn serve

⁠Deploy

Both audit-be and audit-fe are containerized and pushed to Docker Hub⁠. They are tagged based on their application name and version, e.g. daystram/audit:be or daystram/audit:be-v1.1.0.

To run audit-be, run the following:

$ docker run --name audit-be --env-file ./.env -p 8080:8080 -d daystram/audit:be

And audit-fe as follows:

$ docker run --name audit-fe -p 80:80 -d daystram/audit:fe

⁠Dependencies

The following are required for audit-be to function properly:

• InfluxDB
• PostgreSQL

Their credentials must be provided in the configuration file.

⁠Helm Chart

⁠Docker Compose

⁠License

This project is licensed under the MIT License⁠.