telemetry

package
v0.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 5, 2024 License: Apache-2.0, UNKNOWN not legal advice Imports: 0 Imported by: 0

README

Telemetry

The purpose of this package is to provide a way to easily integrate OpenTelemetry Protocol (OTLP) metrics collection into a Tendermint 2 node.

Configure Telemetry

Telemetry can be regularly configured within the TM2 node through the [telemetry] section. It is disabled by default.

OTEL configuration

There are many ways configure the OTEL pipeline for exporting metrics. Here is an example of how a local OTEL collector can be configured to send metrics to Grafana Cloud. This is an optional step and can be highly customized.

OTEL collector

The latest collector releases can be found here. This is an example of the config that can be used to receive metrics from gno.land and publish them to Grafana Cloud.

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317 # should be the same as the TELEM_EXPORTER_ENDPOINT variable

processors:
  batch:

exporters:
  otlphttp:
    endpoint: https://otlp-gateway-prod-us-east-0.grafana.net/otlp

service:
  pipelines:
    metrics:
      receivers: [ otlp ]
      processors: [ batch ]
      exporters: [ otlphttp ]

Collector exporter environment variables, including those for authentication, can be found here.

Resources

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Init

func Init(c config.Config) error

Init initializes the global telemetry

func MetricsEnabled

func MetricsEnabled() bool

MetricsEnabled returns true if metrics have been initialized

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL