Getting started with Uptrace


OpenTelemetryopen in new window is an open source and vendor-neutral API for distributed tracingopen in new window (including logs and errors) and metricsopen in new window.

Getting started with OpenTelemetry and Uptrace is easy:

  1. To host Uptrace yourself, download and install Uptrace binary. Or createopen in new window a free cloud account and let us manage Uptrace for you.

  2. To start receiving data, use the DSN (connection string) you've obtained on the previous step to configure Uptrace distro for your programming language.

  1. Instrument your application with plugins for popular frameworks and libraries.

Have questions? Get help via Telegramopen in new window or start a discussionopen in new window on GitHub.

Infrastructure monitoring

To monitor host (infrastructure) metrics, Redis, PostgreSQL, MySQL and many more, use OpenTelemetry Collector.

If you are using AWS, you can also send CloudWatch Metrics directly to Uptrace.

Logs monitoring

To monitor logs, you can use Vector and FluentBit integrations.

If you are using AWS, you can also send CloudWatch Logs directly to Uptrace.


Uptrace DSN (Data Source Name) is a connection string that is used to connect and send data to an Uptrace backend. It contains an address (host:port) and a secret token that grants write access to a project.

For example, the DSN http://project1_secret_token@localhost:14317/1 contains the following information:

  • http tells the client to disable TLS. Use https to enable TLS.
  • localhost:14317 is an address of the Uptrace backend. The cloud version always uses the address without a port.
  • project1_secret_token is a secret token that is used for authentication.
  • /1 is a project id.

You can always find your project DSN on the project settings page or by clicking on the Help icon:

Uptrace DSN

Resource attributes

Resource attributes are key-value pairs that provide metadata about the entity being monitored, such as a service, process, or container. They help identifying the resource and provide additional information that can be used for filtering and grouping telemetry data.

For the full list of attributes, see Semantic attributesopen in new window, but here are the most popular resource attributes to get you started.

service.nameopen in new windowLogical name of the service. Uptrace provides an overview of all services.
service.versionopen in new windowThe version string of the service API or implementation.
deployment.environmentopen in new windowName of the deployment environment (aka deployment tier). Uptrace can group spans from different environments separately.
host.nameopen in new windowName of the host. Usually, resource detectors discover and set this attribute automatically.

You can set those attributes by using the env resource detector and providing the OTEL_RESOURCE_ATTRIBUTES environment variable:


Or you can configure them during OpenTelemetry initialization:


import ""

    // copy your project DSN here or use UPTRACE_DSN env var


import uptrace

# copy your project DSN here or use UPTRACE_DSN env var

require 'uptrace'

# copy your project DSN here or use UPTRACE_DSN env var
Uptrace.configure_opentelemetry(dsn: '') do |c|
  # c is OpenTelemetry::SDK::Configurator
  c.service_name = 'myservice'
  c.service_version = '1.0.0'

  c.resource = OpenTelemetry::SDK::Resources::Resource.create(
    'deployment.environment' => 'production'

const uptrace = require('@uptrace/node')

    // copy your project DSN here or use UPTRACE_DSN env var
    //dsn: '',
    serviceName: 'myservice',
    serviceVersion: '1.0.0',
    deploymentEnvironment: 'production',
  // Start OpenTelemetry SDK.
  // Then execute the main function when SDK is ready.

$conf = new Uptrace\Config();
// copy your project DSN here or use UPTRACE_DSN env var

$uptrace = new Uptrace\Distro($conf);
$tracerProvider = $uptrace->createTracerProvider();
Last Updated: