Categorygithub.com/stratumn/gomonitoring
package
0.4.8
Repository: https://github.com/stratumn/go.git
Documentation: pkg.go.dev
Overview
Dependencies
18
Dependents
0

# Packages

No description provided by the author

# README

Configuring Monitoring

Our packages export metrics, logs and traces depending on your configuration. To activate monitoring, set the monitoring.active flag to true.

Logs

Logs are written to the standard output using logrus.

Metrics

We support two ways of exposing metrics:

Prometheus

If you want to pull Prometheus metrics, set monitoring.exporter to prometheus. When using Prometheus, you should also set monitoring.metrics.port. Your metrics can then be pulled at {baseURL}:{port}/metrics.

Elastic APM

If you want to use Elastic APM, set monitoring.exporter to elastic.

All the Elastic APM configuration options should be passed as environment variables. Please see the Elastic APM documentation for reference.

The following configuration options are mandatory:

  • ELASTIC_APM_SERVICE_NAME
  • ELASTIC_APM_SERVER_URL
  • ELASTIC_APM_SECRET_TOKEN

We recommend setting the following configuration options too:

  • ELASTIC_APM_ENVIRONMENT (staging/production)
  • ELASTIC_APM_METRICS_INTERVAL if the default 30 seconds doesn't suit you

Traces

Distributed traces are only available when choosing the elastic exporter.

If you use distributed tracing, don't forget to set ELASTIC_APM_TRANSACTION_SAMPLE_RATE to less than 1.0 in production. Distributed tracing is expensive, if you have a lot of requests you can't afford to trace them all.