telemetryapireceiver

README

Telemetry API Receiver

Status
Stability	alpha
Supported pipeline types	traces, logs
Distributions	extension

This receiver generates telemetry in response to events from the Telemetry API. It does this by setting up an endpoint and registering itself with the Telemetry API on startup.

Supported events:

• platform.initStart - The receiver uses this event to record the start time of the function initialization period. Once both start and end times are recorded, the receiver generates a span named platform.initRuntimeDone to record the event.
• platform.initRuntimeDone - The receiver uses this event to record the end time of the function initialization period. Once both start and end times are recorded, the receiver generates a span named platform.initRuntimeDone to record the event.

Configuration

Field	Default	Description
port	4325	HTTP server port to receive Telemetry API data.
types	["platform", "function", "extension"]	Types of telemetry to subscribe to

receivers:
    telemetryapi:
    telemetryapi/1:
      port: 4326
    telemetryapi/2:
      port: 4327
      types:
        - platform
        - function
    telemetryapi/3:
      port: 4328
      types: ["platform", "function"]

Documentation

Overview

Package telemetryapireceiver generates telemetry in response to events from the Telemetry API.

Index

• func NewFactory(extensionID string) receiver.Factory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory(extensionID string) receiver.Factory

NewFactory creates a new receiver factory

Types

type Config

type Config struct {
	Port  int      `mapstructure:"port"`
	Types []string `mapstructure:"types"`
	// contains filtered or unexported fields
}

Config defines the configuration for the various elements of the receiver agent.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate validates the configuration by checking for missing or invalid fields