observability

package module
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Feb 28, 2024 License: Apache-2.0 Imports: 27 Imported by: 6

Documentation

Overview

Package observability implements the tracing, metrics, and logging data collection, and provides controlling knobs via a config file.

Experimental

Notice: This package is EXPERIMENTAL and may be changed or removed in a later release.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func End

func End()

End is the clean-up API for gRPC Observability plugin. It is expected to be invoked in the main function of the application. The suggested usage is "defer observability.End()". This function also flushes data to upstream, and cleanup resources.

Note: this method should only be invoked once.

func Start

func Start(ctx context.Context) error

Start is the opt-in API for gRPC Observability plugin. This function should be invoked in the main function, and before creating any gRPC clients or servers, otherwise, they might not be instrumented. At high-level, this module does the following:

  • it loads observability config from environment;
  • it registers default exporters if not disabled by the config;
  • it sets up telemetry collectors (binary logging sink or StatsHandlers).

Note: this method should only be invoked once. Note: handle the error

Types

This section is empty.

Jump to

Keyboard shortcuts

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