Skip to content

Latest commit

 

History

History
 
 

tk

readme.md

Jsonnet/Tanka

Congratulations! You have successfully found the jsonnet/tanka examples. These examples are meant for advanced users looking to deploy Tempo in a microservices pattern. If you are just getting started might I recommend the docker compose examples. The docker compose examples also are much better at demonstrating trace discovery flows using Loki and other tools.

If you're convinced this is the place for you then keep reading!

Initial Steps

The Jsonnet is meant to be applied to with tanka. To test the jsonnet locally requires:

  • k3d > v3.2.0
  • tanka > v0.12.0

Create a cluster

k3d cluster create tempo --api-port 6443 --port "3000:80@loadbalancer"

If you wish to use a local image, you can import these into k3d

k3d image import grafana/tempo:latest --cluster tempo

Next either deploy the microservices or the single binary. You can also use tanka inline environments to deploy Tempo with either of the two.

Microservices

The microservices deploy of Tempo is fault tolerant, high volume, independently scalable. This jsonnet is in use by Grafana to run our hosted Tempo offering.

# double check you're applying to your local k3d before running this!
tk apply tempo-microservices

Single Binary

** Note: This method of deploying Tempo is referred to by documentation as "monolithic mode" **

The Tempo single binary configuration is currently setup to store traces locally on disk, but can easily be configured to store them in an S3 or GCS bucket. See configuration docs or some of the other examples for help.

# double check you're applying to your local k3d before running this!
tk apply tempo-single-binary

Inline environments

Tanka inline environments allow to programmatically create Tanka environments which are based on either of the two deployments modes described before and which can be then completely customized according to the needs.

The cluster.libsonnet file can be used to specify the deployment mode to use just by changing this line:

    local tempo = import '../tempo-microservices/main.jsonnet',

The above example is for Microservices.

Then the:

    dataOverride: {

section can be used to override anything inside Tempo's deployment.

The following is an example of how to override Tempo's _config:

dataOverride: {
    _config+:: {
        ingester+: {
            pvc_size: '15Gi',
            pvc_storage_class: 'my-storage-class',
        },
    },
},

The very same approach can be used to add new resources to deploy along with Tempo, they just have to be added in the dataOverride object.

This allow the creation of multiple environments with their related customizations in a single point and also allows to reuse the already existing Single Binary and Microservices environments as a "starting point".

Search traces

Once all pods are up and running you can search for traces in Grafana. Navigate to http://localhost:3000/explore and select the search tab.

Dashboards

Dashboards from tempo-mixin are loaded as well. You can find them at http://localhost:3000/dashboards.

Note: these dashboards currently only work well with the microservices deployment.

Clean up

k3d cluster delete tempo