Awesome

<h1> <img src="https://github.com/sighupio/fury-distribution/blob/main/docs/assets/fury-epta-white.png?raw=true" align="left" width="90" style="margin-right: 15px"/> Kubernetes Fury Tracing </h1>

License

Kubernetes Fury Tracing provides a tracing stack for the Kubernetes Fury Distribution (KFD).

If you are new to KFD please refer to the official documentation on how to get started with KFD.

Overview

Kubernetes Fury Tracing uses a collection of open source tools to provide the most resilient and robust tracing stack for the cluster.

The module contains the tempo tool from grafana.

All the components are deployed in the tracing namespace in the cluster.

Package	Version	Description
tempo-distributed	`2.3.1`	Distributed Tempo deployment
minio-ha	`vRELEASE.2023-01-12T02-06-16Z`	Three nodes HA MinIO deployment

Click on each package to see its full documentation.

Compatibility

Kubernetes Version	Compatibility	Notes
`1.26.x`	:white_check_mark:	No known issues
`1.27.x`	:white_check_mark:	No known issues
`1.28.x`	:white_check_mark:	No known issues
`1.29.x`	:white_check_mark:	No known issues

Check the compatibility matrix for additional information about previous releases of the modules.

Usage

Prerequisites

Tool	Version	Description
furyctl	`>=0.25.0`	The recommended tool to download and manage KFD modules and their packages. To learn more about `furyctl` read the official documentation.
kustomize	`>=3.5.3`	Packages are customized using `kustomize`. To learn how to create your customization layer with `kustomize`, please refer to the repository.

Deployment

Include the tracing module configuration in your furyctl.yaml file, specifically under the spec.distribution.modules.tracing section. This streamlined approach enhances the deployment process by seamlessly integrating with the Kubernetes Fury Distribution management tools.

Here is an example snippet for the furyctl.yaml file that demonstrates how to configure the tracing module with Tempo as the tracing system and High Availability (HA) MinIO instance for storage:

spec:
  distribution:
    modules:
      tracing:
        type: tempo
        minio:
          storageSize: "20Gi"

Sending Traces to Tempo

To send traces form an instrumented application to Tempo, point the application to the Distributor's service:

tempo-distributed-distributor.tracing.svc.cluster.local:4317/

> [!NOTE]
> `4317` is the port for the OpenTelemetry Protocol (OTLP), the Distributor supports other protocols but it is recommended to use OTLP for performance reasons.

> [!WARNING]
> For production workloads, it is better to use something like the [OpenTelemetry Collector][otel-collector] instead of pushing the traces directly to Tempo, so the application can oflload the traces quickly and minimize impact on the application's performance.

### Legacy Deployment

1. List the packages you want to deploy and their version in a `Furyfile.yml`

```yaml
bases:
  - name: tracing
    version: "v1.0.3"

See furyctl documentation for additional details about Furyfile.yml format.

Execute furyctl legacy vendor -H to download the packages
Inspect the download packages under ./vendor/katalog/tracing.
Define a kustomization.yaml that includes the ./vendor/katalog/tracing directory as resource.

resources:
- ./vendor/katalog/tracing/minio-ha
- ./vendor/katalog/tracing/tempo-distributed

To deploy the packages to your cluster, execute:

kustomize build . | kubectl apply -f -

Note: When installing the packages, you need to ensure that the Prometheus operator is also installed. Otherwise, the API server will reject all ServiceMonitor resources.

Contributing

Before contributing, please read first the Contributing Guidelines.

Reporting Issues

In case you experience any problems with the module, please open a new issue.

License

This module is open-source and it's released under the following LICENSE