8000 add restricted registry documentation by remijouannet · Pull Request #968 · prometheus/client_python · GitHub
[go: up one dir, main page]
Skip to content

add restricted registry documentation #968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 24, 2023
Merged

add restricted registry documentation #968

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f533910
add restricted registry documentation
remijouannet Oct 19, 2023
3c9065c
remove curl verbose in readme
remijouannet Oct 24, 2023
5f2633c
show example for generate_latest
remijouannet Oct 24, 2023
cc43fe0
Update README.md
remijouannet Oct 24, 2023
eba0e01
Update README.md
remijouannet Oct 24, 2023
3418d14
Update README.md
remijouannet Oct 24, 2023
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
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -737,6 +737,39 @@ for family in text_string_to_metric_families(u"my_gauge 1.0\n"):
print("Name: {0} Labels: {1} Value: {2}".format(*sample))
```

## Restricted registry

Registry support querying a specific metric with the GET parameter "name[]".
Since it's an array it can be use multiple times.

```python
curl -v --get --data-urlencode "name[]=python_gc_objects_collected_total" --data-urlencode "name[]=python_info" http://127.0.0.1:9200/metrics
* About to connect() to 127.0.0.1 port 9200 (#0)
* Trying 127.0.0.1...
* Connected to 127.0.0.1 (127.0.0.1) port 9200 (#0)
> GET /metrics?name[]=python_gc_objects_collected_total&name[]=python_info HTTP/1.1
> User-Agent: curl/7.29.0
> Host: 127.0.0.1:9200
> Accept: */*
>
* HTTP 1.0, assume close after body
< HTTP/1.0 200 OK
< Date: Thu, 19 Oct 2023 10:00:38 GMT
< Server: WSGIServer/0.2 CPython/3.9.3
< Content-Type: text/plain; version=0.0.4; charset=utf-8
< Content-Length: 454
<
# HELP python_info Python platform information
# TYPE python_info gauge
python_info{implementation="CPython",major="3",minor="9",patchlevel="3",version="3.9.3"} 1.0
# HELP python_gc_objects_collected_total Objects collected during gc
# TYPE python_gc_objects_collected_total counter
python_gc_objects_collected_total{generation="0"} 73129.0
python_gc_objects_collected_total{generation="1"} 8594.0
python_gc_objects_collected_total{generation="2"} 296.0
* Closing connection 0
```

## Links

* [Releases](https://github.com/prometheus/client_python/releases): The releases page shows the history of the project and acts as a changelog.
Expand Down
0