Open Metrics

JFrog Platform Administration Documentation

Content Type
Administration / Platform
ft:sourceType
Paligo

Subscription Information

This feature is supported on the Self-Hosted platform, with a Pro, Pro X, Enterprise X, or Enterprise+ license.

Open Metrics is an open standard for exposing and transmitting metrics from applications and services. It provides a common, easy-to-read format that can be utilized by different monitoring tools and systems. Unlike JMX MBeans, which is specifically designed to monitor Java applications (such as the main Artifactory service), Open Metrics can be used to monitor other Artifactory services and microservices that are written in programming languages other than Java. The JFrog Platform supports Open Metrics for Self-Hosted customers (the functionality is not supported for JFrog Cloud customers).JFrog Artifactory Product

Credentials for Accessing Open Metrics

From Artifactory version 7.21.1, an admin user can create a scoped access token using system:metrics:r and use that as the credentials for getting the service metrics. The admin can create read-only access token to get metrics, which then enables anyone with the read-only token to read metrics. To learn more, see Access Tokens.

To enable metrics in Artifactory, set the following values in the Artifactory System YAML file to true:Artifactory System YAML

  • shared.metrics.enabled

  • artifactory.metrics.enabled

  • event.metrics.enabled

  • access.metrics.enabled

  • observability.metrics.enabled

You must restart Artifactory for the changes to take effect.

To enable metrics in Xray, make the following configuration change to the Xray System YAML:Xray System YAML

openMetrics:
    enabled: true