Interface GitHubAppRuntimeConfig.Telemetry

Enclosing interface:
GitHubAppRuntimeConfig

public static interface GitHubAppRuntimeConfig.Telemetry
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Whether telemetry metrics integration is active at runtime or not.
    boolean
    Whether we record the command in the OpenTelemetry event.
    boolean
    Whether we record the event JSON payloads in the OpenTelemetry spans.
    boolean
    Whether telemetry span collecting integration is active at runtime or not.
  • Method Details

    • tracesActive

      @WithDefault("true") @WithName("traces.active") boolean tracesActive()
      Whether telemetry span collecting integration is active at runtime or not.

      Always inactive if the telemetry integration is not present or disabled at build time.

    • metricsActive

      @WithDefault("true") @WithName("metrics.active") boolean metricsActive()
      Whether telemetry metrics integration is active at runtime or not.

      Always inactive if the telemetry integration is not present or disabled at build time.

    • recordEventPayload

      @WithDefault("false") boolean recordEventPayload()
      Whether we record the event JSON payloads in the OpenTelemetry spans.

      The payload is only recorded in the root github-event span.

    • recordCommand

      @WithDefault("false") boolean recordCommand()
      Whether we record the command in the OpenTelemetry event.

      Only useful when using the command-airline extension.