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.

TracePipeline.telemetry.kyma-project.io/v1alpha1

Spec:

Parameter	Type	Description
output (required)	object	Defines a destination for shipping trace data. Only one can be defined per pipeline.
output.otlp (required)	object	Configures the underlying Otel Collector with an OTLP exporter. If you switch `protocol`to `http`, an OTLP HTTP exporter is used.
output.otlp.authentication	object	Defines authentication options for the OTLP output
output.otlp.authentication.basic	object	Activates `Basic` authentication for the destination providing relevant Secrets.
output.otlp.authentication.basic.password (required)	object	Contains the basic auth password or a Secret reference.
output.otlp.authentication.basic.password.value	string	Value that can contain references to Secret values.
output.otlp.authentication.basic.password.valueFrom	object
output.otlp.authentication.basic.password.valueFrom.secretKeyRef	object	Refers to a key in a Secret. You must provide `name` and `namespace` of the Secret, as well as the name of the `key`.
output.otlp.authentication.basic.password.valueFrom.secretKeyRef.key	string
output.otlp.authentication.basic.password.valueFrom.secretKeyRef.name	string
output.otlp.authentication.basic.password.valueFrom.secretKeyRef.namespace	string
output.otlp.authentication.basic.user (required)	object	Contains the basic auth username or a Secret reference.
output.otlp.authentication.basic.user.value	string	Value that can contain references to Secret values.
output.otlp.authentication.basic.user.valueFrom	object
output.otlp.authentication.basic.user.valueFrom.secretKeyRef	object	Refers to a key in a Secret. You must provide `name` and `namespace` of the Secret, as well as the name of the `key`.
output.otlp.authentication.basic.user.valueFrom.secretKeyRef.key	string
output.otlp.authentication.basic.user.valueFrom.secretKeyRef.name	string
output.otlp.authentication.basic.user.valueFrom.secretKeyRef.namespace	string
output.otlp.endpoint (required)	object	Defines the host and port (:) of an OTLP endpoint.
output.otlp.endpoint.value	string	Value that can contain references to Secret values.
output.otlp.endpoint.valueFrom	object
output.otlp.endpoint.valueFrom.secretKeyRef	object	Refers to a key in a Secret. You must provide `name` and `namespace` of the Secret, as well as the name of the `key`.
output.otlp.endpoint.valueFrom.secretKeyRef.key	string
output.otlp.endpoint.valueFrom.secretKeyRef.name	string
output.otlp.endpoint.valueFrom.secretKeyRef.namespace	string
output.otlp.headers	[]object	Defines custom headers to be added to outgoing HTTP or GRPC requests.
output.otlp.headers.name (required)	string	Defines the header name.
output.otlp.headers.value	string	Value that can contain references to Secret values.
output.otlp.headers.valueFrom	object
output.otlp.headers.valueFrom.secretKeyRef	object	Refers to a key in a Secret. You must provide `name` and `namespace` of the Secret, as well as the name of the `key`.
output.otlp.headers.valueFrom.secretKeyRef.key	string
output.otlp.headers.valueFrom.secretKeyRef.name	string
output.otlp.headers.valueFrom.secretKeyRef.namespace	string
output.otlp.protocol	string	Defines the OTLP protocol (http or grpc). Default is GRPC.

Status:

Parameter	Type	Description
conditions	[]object	An array of conditions describing the status of the pipeline.
conditions.lastTransitionTime	string	An array of conditions describing the status of the pipeline.
conditions.reason	string	An array of conditions describing the status of the pipeline.
conditions.type	string	The possible transition types are:- `Running`: The instance is ready and usable.- `Pending`: The pipeline is being activated.