Loading

Elastic Package Registry

Version 0.4.0 (View all)
Subscription level
What's this?
Basic
Developed by
What's this?
Elastic
Ingestion method(s) Prometheus
Minimum Kibana version(s) 9.4.4
The Elastic Package Registry integration v0.4.0 is in technical preview

To use pre-release integrations, go to the Integrations page in Kibana, scroll down, and toggle on the Display beta integrations option.

The Elastic Package Registry integration collects metrics from your Elastic Package Registry service.

Use the data from this integration to monitor the status of your services — for example, how many packages are indexed, which versions your services are running, or whether there are too many requests with 404 or 500 status codes.

This integration is compatible with Elastic Package Registry version 1.10.0 and later.

The integration uses the Prometheus input to collect metrics from the /metrics endpoint exposed by the Elastic Package Registry service.

The Elastic Package Registry integration collects the following type of data:

  • Metrics: Telemetry data from the /metrics endpoint that gives you insight into the state of the services. See Metrics for details.

You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.

Elastic Agent must be installed. For more details, check the Elastic Agent installation instructions. You can install only one Elastic Agent per host.

Elastic Agent is required to stream data from the Elastic Package Registry metrics endpoint and ship the data to Elastic, where the events will then be processed via the integration's ingest pipelines.

To enable telemetry in your Elastic Package Registry instance, set the metrics address parameter. Alternatively, set the EPR_METRICS_ADDRESS environment variable:

package-registry -metrics-address 0.0.0.0:9000

EPR_METRICS_ADDRESS="0.0.0.0:9000" package-registry
		

Remember to expose the port used in the above setting (for example, 9000) in your deployments: k8s, docker-compose, and so on.

For step-by-step instructions on how to set up an integration, see the Getting started guide.

Verify that the metrics endpoint is enabled by making an HTTP request to http://localhost:9000/metrics on your package registry instance.

For more information on architectures that can be used for scaling this integration, check the Ingest Architectures documentation.

This integration uses the prometheus_input package. The following input is used:

The metrics data stream provides Prometheus metrics from the /metrics endpoint of the Elastic Package Registry service.

This integration includes one or more Kibana dashboards that visualizes the data collected by the integration. The screenshots below illustrate how the ingested data is displayed.