Skip to content

TelemetrySection class

Bases: UniqueSection

Configuration fields needed to configure telemetry.

When enabled, the Taipy application will connect to the Open Telemetry endpoint specified (or "localhost" if not) to send metrics to.

Attributes

enabled property writable

enabled: bool

enable telemetry. Default is "false".

id instance-attribute

id: str = _validate_id(id)

A valid python identifier that uniquely identifies the section.

otel_endpoint property writable

otel_endpoint: str

The Open Telemetry endpoint.

properties property writable

properties

A dictionary of additional properties.

service_name property writable

service_name: str

The application name.

Methods

default_config() classmethod

default_config() -> TelemetrySection

Create a default configuration for the telemetry section.

Returns:

Type Description
TelemetrySection

the default configuration.