Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

DocumentationTempo documentationSet up a Tempo server or clusterUpgrade

Upgrade Tempo

You can upgrade an existing Tempo installation to the next version. However, any new release has the potential to have breaking changes that should be tested in a non-production environment prior to rolling these changes to production.

The upgrade process changes for each version, depending upon the changes made for the subsequent release.

This upgrade guide applies to on-premise installations and not for Grafana Cloud.

TIP: You can check your configuration options using the status API endpoint in your Tempo installation.

Upgrade from Tempo 1.5 to 2.0

Tempo 2.0 marks a major milestone in Tempo’s development. When planning your upgrade, consider these factors:

• Breaking changes:
  • Renamed, removed, and moved configurations are described in section below.
  • The TempoRequestErrors alert was removed from mixin. Any Jsonnet users relying on this alert should copy this into their own environment.
• Advisory:
  • Changed defaults – Are these updates relevant for your installation?
  • TraceQL editor needs to be enabled in Grafana to use the query editor.
  • Resource requirements have changed for Tempo 2.0 with the default configuration.

Once you upgrade to Tempo 2.0, there is no path to downgrade.

Note: There is a potential issue loading Tempo 1.5’s experimental Parquet storage blocks. You may see errors or even panics in the compactors. We have only been able to reproduce this with interim commits between 1.5 and 2.0, but if you experience any issues please report them so we can isolate and fix this issue.

Check Tempo installation resource allocation

Parquet provides faster search and is required to enable TraceQL. However, the Tempo installation will require additional CPU and memory resources to use Parquet efficiently. Parquet is more costly due to the extra work of building the columnar blocks, and operators should expect at least 1.5x increase in required resources to run a Tempo 2.0 cluster. Most users will find these extra resources are negligible compared to the benefits that come from the additional features of TraceQL and from storing traces in an open format.

You can can continue using the previous v2 block format using the instructions provided in the Parquet configuration documentation. Tempo will continue to support trace by id lookup on the v2 format for the foreseeable future.

Enable TraceQL in Grafana

TraceQL is enabled by default in Tempo 2.0. The TraceQL query editor requires Grafana 9.3.2 and later.

The TraceQL query editor is in beta in Grafana 9.3.2 and needs to be enabled with the traceqlEditor feature flag.

Check configuration options for removed and renamed options

The following tables describe the parameters that have been removed or renamed.

Removed and replaced

query_frontend:
  query_shards:

querier:
  query_timeout:

ingester:
  use_flatbuffer_search:

Renamed

The following compactor configuration parameters were renamed.

compaction:
  chunk_size_bytes:

compaction:
  flush_size_bytes:

compaction:
  iterator_buffer_size:

The following storage configuration parameters were renamed.

wal:
  encoding:

block:
  index_downsample_bytes:

block:
  index_page_size_bytes:

block:
  encoding:

block:
  row_group_size_bytes:

The Azure Storage configuration section now uses snake case with underscores (_) instead of dashes (-). Example of using snake case on Azure Storage config:

yaml Copy

# config.yaml
storage:
  trace:
    azure:
      storage_account_name:
      storage_account_key:
      container_name: