Version:

Telemetry - TracePipeline

The tracepipeline.telemetry.kyma-project.io CustomResourceDefinition (CRD) is a detailed description of the kind of data and the format used to filter and ship trace data in Kyma. To get the up-to-date CRD and show the output in the YAML format, run this command:

Click to copy

kubectl get crd tracepipeline.telemetry.kyma-project.io -o yaml

Sample custom resource

The following TracePipeline object defines a pipeline integrating into the local Jaeger instance.

Click to copy

apiVersion: telemetry.kyma-project.io/v1alpha1
kind: TracePipeline
metadata:
  name: jaeger
spec:
  output:
    otlp:
      endpoint:
        value: http://jaeger-collector.jaeger.svc.cluster.local:4317
status:
  conditions:
  - lastTransitionTime: "2022-12-13T14:33:27Z"
    reason: OpenTelemetryDeploymentNotReady
    type: Pending
  - lastTransitionTime: "2022-12-13T14:33:28Z"
    reason: OpenTelemetryDeploymentReady
    type: Running

For further TracePipeline examples, see the samples directory.

Custom resource parameters

For details, see the TracePipeline specification file.

Parameter	Description
spec.output	Defines a destination for shipping trace data. Only one can be defined per pipeline.
spec.output.otlp	Configures the underlying Otel Collector with an OTLP exporter. If you switch `protocol`to `http`, an OTLP HTTP exporter is used.
spec.output.otlp.authentication	Defines authentication options for the OTLP output
spec.output.otlp.authentication.basic	Activates `Basic` authentication for the destination providing relevant Secrets.
spec.output.otlp.authentication.basic.password	Contains the basic auth password or a Secret reference.
spec.output.otlp.authentication.basic.password.value	Value that can contain references to Secret values.
spec.output.otlp.authentication.basic.password.valueFrom
spec.output.otlp.authentication.basic.password.valueFrom.secretKeyRef	Refers to a key in a Secret. You must provide `name` and `namespace` of the Secret, as well as the name of the `key`.
spec.output.otlp.authentication.basic.password.valueFrom.secretKeyRef.key
spec.output.otlp.authentication.basic.password.valueFrom.secretKeyRef.name
spec.output.otlp.authentication.basic.password.valueFrom.secretKeyRef.namespace
spec.output.otlp.authentication.basic.user	Contains the basic auth username or a Secret reference.
spec.output.otlp.authentication.basic.user.value	Value that can contain references to Secret values.
spec.output.otlp.authentication.basic.user.valueFrom
spec.output.otlp.authentication.basic.user.valueFrom.secretKeyRef	Refers to a key in a Secret. You must provide `name` and `namespace` of the Secret, as well as the name of the `key`.
spec.output.otlp.authentication.basic.user.valueFrom.secretKeyRef.key
spec.output.otlp.authentication.basic.user.valueFrom.secretKeyRef.name
spec.output.otlp.authentication.basic.user.valueFrom.secretKeyRef.namespace
spec.output.otlp.endpoint	Defines the host and port (:) of an OTLP endpoint.
spec.output.otlp.endpoint.value	Value that can contain references to Secret values.
spec.output.otlp.endpoint.valueFrom
spec.output.otlp.endpoint.valueFrom.secretKeyRef	Refers to a key in a Secret. You must provide `name` and `namespace` of the Secret, as well as the name of the `key`.
spec.output.otlp.endpoint.valueFrom.secretKeyRef.key
spec.output.otlp.endpoint.valueFrom.secretKeyRef.name
spec.output.otlp.endpoint.valueFrom.secretKeyRef.namespace
spec.output.otlp.headers	Defines custom headers to be added to outgoing HTTP or GRPC requests.
spec.output.otlp.headers.name	Defines the header name.
spec.output.otlp.headers.value	Value that can contain references to Secret values.
spec.output.otlp.headers.valueFrom
spec.output.otlp.headers.valueFrom.secretKeyRef	Refers to a key in a Secret. You must provide `name` and `namespace` of the Secret, as well as the name of the `key`.
spec.output.otlp.headers.valueFrom.secretKeyRef.key
spec.output.otlp.headers.valueFrom.secretKeyRef.name
spec.output.otlp.headers.valueFrom.secretKeyRef.namespace
spec.output.otlp.protocol	Defines the OTLP protocol (http or grpc). Default is GRPC.
status.conditions	An array of conditions describing the status of the pipeline.
status.conditions.lastTransitionTime	An array of conditions describing the status of the pipeline.
status.conditions.reason	An array of conditions describing the status of the pipeline.
status.conditions.type	The possible transition types are:- `Running`: The instance is ready and usable.- `Pending`: The pipeline is being activated.