Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion blog/posts/2024-03-14-commitment-to-opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ In [Prometheus v2.47.0](https://github.com/prometheus/prometheus/releases/tag/v2

### Support UTF-8 metric and label names

[OpenTelemetry semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md) push for `“.”` to be the namespacing character. For example, `http.server.request.duration`. However, Prometheus currently requires a [more limited character set](https://prometheus.io/docs/instrumenting/writing_exporters/#naming), which means we convert the metric to `http_server_request_duration` when ingesting it into Prometheus.
[OpenTelemetry semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md) push for `“.”` to be the namespacing character. For example, `http.server.request.duration`. However, Prometheus currently requires a [more limited character set](https://prometheus.io/docs/exporters/writing-exporters/#naming), which means we convert the metric to `http_server_request_duration` when ingesting it into Prometheus.

This causes unnecessary dissonance and we’re working on removing this limitation by adding UTF-8 support for all labels and metric names. The progress is tracked [here](https://github.com/prometheus/prometheus/issues/13095).

Expand Down
9 changes: 9 additions & 0 deletions docs-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,24 @@ export default {
repo: "prometheus",
repoDocsDir: "docs",
slugPrefix: "prometheus",
versioning: "release-branches",
minNumVersions: 10,
},
{
owner: "prometheus",
repo: "alertmanager",
repoDocsDir: "docs",
slugPrefix: "alerting",
versioning: "release-branches",
minNumVersions: 8,
},
{
owner: "prometheus-community",
repo: "postgres_exporter",
repoDocsDir: "docs",
slugPrefix: "exporters/postgres",
versioning: "latest-release-tag",
},
],

// Single pages to fetch from external repos (not versioned).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Exporters and integrations
sort_rank: 4
sort_rank: 1
---

There are a number of libraries and servers which help in exporting existing
Expand All @@ -14,7 +14,7 @@ Some of these exporters are maintained as part of the official [Prometheus GitHu
those are marked as *official*, others are externally contributed and maintained.

We encourage the creation of more exporters but cannot vet all of them for
[best practices](/docs/instrumenting/writing_exporters/).
[best practices](/docs/exporters/writing-exporters/).
Commonly, those exporters are hosted outside of the Prometheus GitHub
organization.

Expand Down Expand Up @@ -50,7 +50,7 @@ wide variety of JVM-based applications, for example [Kafka](http://kafka.apache.
* [OpenTSDB Exporter](https://github.com/cloudflare/opentsdb_exporter)
* [Oracle DB Exporter](https://github.com/iamseth/oracledb_exporter)
* [PgBouncer exporter](https://github.com/prometheus-community/pgbouncer_exporter)
* [PostgreSQL exporter](https://github.com/prometheus-community/postgres_exporter)
* [PostgreSQL exporter](/docs/exporters/postgres/) ([source](https://github.com/prometheus-community/postgres_exporter))
* [Presto exporter](https://github.com/yahoojapan/presto_exporter)
* [ProxySQL exporter](https://github.com/percona/proxysql_exporter)
* [RavenDB exporter](https://github.com/marcinbudny/ravendb_exporter)
Expand Down Expand Up @@ -290,7 +290,7 @@ wide variety of JVM-based applications, for example [Kafka](http://kafka.apache.


When implementing a new Prometheus exporter, please follow the
[guidelines on writing exporters](/docs/instrumenting/writing_exporters)
[guidelines on writing exporters](/docs/exporters/writing-exporters/)
Please also consider consulting the [development mailing
list](https://groups.google.com/forum/#!forum/prometheus-developers). We are
happy to give advice on how to make your exporter as useful and consistent as
Expand Down
19 changes: 19 additions & 0 deletions docs/exporters/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Exporters
sort_rank: 6
nav_icon: package
---

Exporters expose metrics from systems that cannot be instrumented directly with
Prometheus client libraries. The exporter documentation in this section is
maintained in each exporter's own repository and pulled into this website from
the latest stable release.

The broader catalog of available exporters and integrations is listed in
[Exporters and integrations](/docs/exporters/exporters-and-integrations/).

## Documented exporters

* [PostgreSQL exporter](/docs/exporters/postgres/) (coming from
[prometheus-community/postgres_exporter](https://github.com/prometheus-community/postgres_exporter))

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Writing exporters
sort_rank: 5
sort_rank: 2
---

If you are instrumenting your own code, the [general rules of how to
Expand Down Expand Up @@ -529,5 +529,5 @@ port allocations.

Once you’re ready to announce your exporter to the world, email the
mailing list and send a PR to add it to [the list of available
exporters](/docs/instrumenting/exporters/) by editing [this GitHub
repository file](https://github.com/prometheus/docs/blob/main/docs/instrumenting/exporters.md).
exporters](/docs/exporters/exporters-and-integrations/) by editing [this GitHub
repository file](https://github.com/prometheus/docs/blob/main/docs/exporters/exporters-and-integrations.md).
2 changes: 1 addition & 1 deletion docs/guides/multi-target-exporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This guide will introduce you to the multi-target exporter pattern. To achieve t

## The multi-target exporter pattern?

By multi-target [exporter](/docs/instrumenting/exporters/) pattern we refer to a specific design, in which:
By multi-target [exporter](/docs/exporters/exporters-and-integrations/) pattern we refer to a specific design, in which:

* the exporter will get the target’s metrics via a network protocol.
* the exporter does not have to run on the machine the metrics are taken from.
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ jobs.

### What applications can Prometheus monitor out of the box?

See [the list of exporters and integrations](/docs/instrumenting/exporters/).
See [the list of exporters and integrations](/docs/exporters/exporters-and-integrations/).

### Can I monitor JVM applications via JMX?

Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ optional:
* the main [Prometheus server](https://github.com/prometheus/prometheus) which scrapes and stores time series data
* [client libraries](/docs/instrumenting/clientlibs/) for instrumenting application code
* a [push gateway](https://github.com/prometheus/pushgateway) for supporting short-lived jobs
* special-purpose [exporters](/docs/instrumenting/exporters/) for services like HAProxy, StatsD, Graphite, etc.
* special-purpose [exporters](/docs/exporters/exporters-and-integrations/) for services like HAProxy, StatsD, Graphite, etc.
* an [alertmanager](https://github.com/prometheus/alertmanager) to handle alerts
* various support tools

Expand Down
2 changes: 1 addition & 1 deletion docs/operating/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sort_rank: 5
---

In addition to [client libraries](/docs/instrumenting/clientlibs/) and
[exporters and related libraries](/docs/instrumenting/exporters/), there are
[exporters and related libraries](/docs/exporters/exporters-and-integrations/), there are
numerous other generic integration points in Prometheus. This page lists some
of the integrations with these.

Expand Down
2 changes: 1 addition & 1 deletion docs/specs/prw/remote_write_spec_2_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ Typically, Senders can detect when a time series will no longer be appended usin

#### Metadata

Metadata SHOULD follow the official Prometheus guidelines for [Type](https://prometheus.io/docs/instrumenting/writing_exporters/#types) and [Help](https://prometheus.io/docs/instrumenting/writing_exporters/#help-strings).
Metadata SHOULD follow the official Prometheus guidelines for [Type](https://prometheus.io/docs/exporters/writing-exporters/#types) and [Help](https://prometheus.io/docs/exporters/writing-exporters/#help-strings).

Metadata MAY follow the official OpenMetrics guidelines for [Unit](https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#unit).

Expand Down
4 changes: 4 additions & 0 deletions public/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ https://openmetrics.io/* https://prometheus.io/docs/specs/om/open_metrics_spec 3
# Redirect for HTTP SD docs, which briefly lived in the wrong category / repo.
/docs/instrumenting/http_sd/ /docs/prometheus/latest/http_sd/

# Moved exporter docs into their own section.
/docs/instrumenting/exporters/ /docs/exporters/exporters-and-integrations/ 302!
/docs/instrumenting/writing_exporters/ /docs/exporters/writing-exporters/ 302!

# Redirect for "disabled_features", which is now called "feature_flags".
/docs/prometheus/latest/disabled_features/ /docs/prometheus/latest/feature_flags/

Expand Down
Loading
Loading