Skip to content

Commit 5a5b8fb

Browse files
miharpclaude
andcommitted
Modernize orphaned metrics pages, add Metrics nav section (fixes OpenVoxProject#157)
- Add dedicated "Metrics" nav section combining three conceptual pages with the existing v1/v2 metrics API endpoint pages - Rebrand Puppet Server → OpenVox Server throughout all three pages - Rebrand PuppetDB → OpenVoxDB in prose; keep puppetlabs. metric name prefixes and puppetdb metric path segments as-is (runtime format) - Remove PE block, JIRA ticket links, and puppet.com-only links - Replace "compile masters" with "compilers"; "master" with "server" - Update recommended FOSS dashboard module to puppet-operational-dashboards - Retitle grafanadash/puppet-graphite as community modules - Add "OpenVoxDB metrics" section heading with compat note re: metric names Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
1 parent cde1b87 commit 5a5b8fb

4 files changed

Lines changed: 141 additions & 148 deletions

File tree

_data/nav/openvox-server_8x.yml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,11 +100,17 @@
100100
link: status-api/v1/services.html
101101
- text: Simple endpoint
102102
link: status-api/v1/simple.html
103-
- text: Metrics API endpoints
103+
- text: Metrics
104104
items:
105-
- text: v1 metrics
105+
- text: Monitoring OpenVox Server metrics
106+
link: puppet_server_metrics.html
107+
- text: HTTP client metrics
108+
link: http_client_metrics.html
109+
- text: Applying metrics to improve performance
110+
link: puppet_server_metrics_performance.html
111+
- text: v1 metrics API
106112
link: metrics-api/v1/metrics_api.html
107-
- text: v2 (Jolokia) metrics
113+
- text: v2 (Jolokia) metrics API
108114
link: metrics-api/v2/metrics_api.html
109115
- text: Developer information
110116
items:

docs/_openvox-server_8x/http_client_metrics.markdown

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
22
layout: default
3-
title: "Puppet Server: HTTP Client Metrics"
4-
canonical: "/puppetserver/latest/http_client_metrics.html"
3+
title: "OpenVox Server: HTTP Client Metrics"
54
---
65

76
[status API]: ./status-api/v1/services.html
87

9-
HTTP client metrics available in Puppet Server 5 allows users to measure how long it takes for Puppet Server to make requests to and receive responses from other services, such as PuppetDB.
8+
HTTP client metrics allow users to measure how long it takes for OpenVox Server to make requests to and receive responses from other services, such as OpenVoxDB.
109

1110
## Determining metrics IDs
1211

@@ -16,19 +15,19 @@ All of these metrics are of the form `puppetlabs.<SERVER ID>.http-client.experim
1615
> are joined together with periods. For instance, the metric ID of `[puppetdb resource search]` is `puppetdb.resource.search`, so the full metric name would be
1716
> `puppetlabs.<server-id>.http-client.experimental.with-metric-id.puppetdb.resource.search.full-response`.
1817
19-
You can configure PuppetDB to be a backend for [configuration files](https://puppet.com/docs/puppetdb/latest/connect_puppet_master.html#step-2-edit-configuration-files) (through the `storeconfigs` setting), and
20-
you can configure Puppet Server to send reports to an external report processing service. If you configure either of these, then during the course of handling a Puppet agent run, Puppet Server makes several
18+
You can configure OpenVoxDB to be a backend for configuration files (through the `storeconfigs` setting), and
19+
you can configure OpenVox Server to send reports to an external report processing service. If you configure either of these, then during the course of handling an OpenVox agent run, OpenVox Server makes several
2120
calls to external services to retrieve or store information.
2221

23-
- During handling of a `/puppet/v3/node` request, Puppet Server issues:
24-
- a `facts find` request to PuppetDB for facts about the node, if they aren't yet cached (typically the first time it requests facts for the node). **Metric ID:** `[puppetdb facts find]`.
25-
- During handling of a `/puppet/v3/catalog` request, Puppet Server issues several requests:
26-
- a PuppetDB `replace facts` request, to replace the facts for the agent in PuppetDB with the facts it received from the agent. **Metric ID:** `[puppetdb, command, replace_facts]`.
27-
- a PuppetDB `resource search` request, to search for resources if exported resources are used. **Metric ID:** `[puppetdb, resource, search]`.
28-
- a PuppetDB `query` request, if the `puppetdb_query` function is used in Puppet code. **Metric ID:** `[puppetdb, query]`.
29-
- a PuppetDB `replace catalog` request, to replace the catalog for the agent in PuppetDB with the newly compiled catalog. **Metric ID:** `[puppetdb, command, replace_catalog]`.
30-
- During handling of a `/puppet/v3/report` request, Puppet Server issues:
31-
- a PuppetDB `store report` request, to store the submitted report. **Metric ID:** `[puppetdb command store_report]`.
22+
- During handling of a `/puppet/v3/node` request, OpenVox Server issues:
23+
- a `facts find` request to OpenVoxDB for facts about the node, if they aren't yet cached (typically the first time it requests facts for the node). **Metric ID:** `[puppetdb facts find]`.
24+
- During handling of a `/puppet/v3/catalog` request, OpenVox Server issues several requests:
25+
- an OpenVoxDB `replace facts` request, to replace the facts for the agent in OpenVoxDB with the facts it received from the agent. **Metric ID:** `[puppetdb, command, replace_facts]`.
26+
- an OpenVoxDB `resource search` request, to search for resources if exported resources are used. **Metric ID:** `[puppetdb, resource, search]`.
27+
- an OpenVoxDB `query` request, if the `puppetdb_query` function is used in Puppet code. **Metric ID:** `[puppetdb, query]`.
28+
- an OpenVoxDB `replace catalog` request, to replace the catalog for the agent in OpenVoxDB with the newly compiled catalog. **Metric ID:** `[puppetdb, command, replace_catalog]`.
29+
- During handling of a `/puppet/v3/report` request, OpenVox Server issues:
30+
- an OpenVoxDB `store report` request, to store the submitted report. **Metric ID:** `[puppetdb command store_report]`.
3231
- a request to the configured `reports_url` to store the report, if the HTTP report processor is enabled. **Metric ID:** `[puppetdb report http]`.
3332

3433
## Configuring
@@ -38,8 +37,8 @@ HTTP client metrics are enabled by default, but can be disabled by setting `metr
3837
These metrics also depend on the `server-id` setting in the `metrics` section of `puppetserver.conf`. This defaults to `localhost`, and while `localhost` can collect metrics, change this setting to something
3938
unique to avoid metric naming collisions when exporting metrics to an external tool, such as Graphite.
4039

41-
This data is all available via the [status API][] endpoint, at `https://<MASTER HOSTNAME>:8140/status/v1/services/master?level=debug`. Puppet Server 5.0 adds a `http-client-metrics` keyword in the map. If
42-
metrics are not enabled, or if Puppet Server has not issued any requests yet, then this array will be empty, like so: `"http-client-metrics": []`.
40+
This data is all available via the [status API][] endpoint, at `https://<SERVER HOSTNAME>:8140/status/v1/services/master?level=debug`. If
41+
metrics are not enabled, or if OpenVox Server has not issued any requests yet, then this array will be empty, like so: `"http-client-metrics": []`.
4342

4443
In the [sample Grafana dashboard](./sample-puppetserver-metrics-dashboard.json), the `External HTTP Communications` graph visualizes all of these metrics, and the tooltip describes each of them.
4544

0 commit comments

Comments
 (0)