Type to search.

Configuration file of the Universal Profiling Agent

Serverless Unavailable

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Unavailable

    This functionality is not available in Elastic Cloud Serverless.

Stack

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

The Universal Profiling Agent can be configured using a configuration file. Specify the path to the configuration file using the CLI argument -config. The default path for the configuration file is /etc/Elastic/universal-profiling/pf-host-agent.conf.

The expected format of the configuration file is a plaintext file, where each line holds one option.

Example:

Text 
project-id: 73
secret-token: abc123
collection-agent: example.com:443
Warning

Command line arguments to the Universal Profiling Agent take precedence over environment variables, and environment variables take precedence over the configuration file.

Config file option Type Example Description
verbose bool verbose: true Run the Universal Profiling Agent in verbose mode.
no-kernel-version-check bool no-kernel-version-check: true Disable the kernel version check. See Override kernel version check for more details.
tags string tags: 'cloud_region:us-central1;env:staging' Set specific tags. See Tag data for querying for more details.
project-id uint project-id: 73 Splits profiling data into logical groups that you control. You can assign any non-zero, unsigned integer ⇐ 4095.
secret-token string secret-token: abc123 Set the secret token for communicating with the Universal Profiling Collector to abc123.
collection-agent string collection-agent: example.com:443 Set the destination for reporting profiling information to example.com:443.
probabilistic-interval duration probabilistic-interval: 2m30s Set the probabilistic interval to 2m30s. See Probabilistic profiling for more details.
probabilistic-threshold uint probabilistic-threshold: 50 Set the probabilistic threshold to 50. See Probabilistic profiling for more details.