ホーム
製品
OpenShift Container Platform
4.2
Registry
5.4. Accessing registry metrics

5.4. Accessing registry metrics

The OpenShift Container Registry provides an endpoint for Prometheus metrics. Prometheus is a stand-alone, open source systems monitoring and alerting toolkit.

The metrics are exposed at the /extensions/v2/metrics path of the registry endpoint.

Procedure

There are two ways in which you can access the metrics, running a metrics query or using the cluster role.

Metrics query

Run a metrics query, for example:

curl --insecure -s -u <user>:<secret> \
    https://image-registry.openshift-image-registry.svc:5000/extensions/v2/metrics | grep imageregistry | head -n 20
HELP imageregistry_build_info A metric with a constant '1' value labeled by major, minor, git commit & git version from which the image registry was built.
TYPE imageregistry_build_info gauge
HELP imageregistry_digest_cache_requests_total Total number of requests without scope to the digest cache.
TYPE imageregistry_digest_cache_requests_total counter
HELP imageregistry_digest_cache_scoped_requests_total Total number of scoped requests to the digest cache.
TYPE imageregistry_digest_cache_scoped_requests_total counter
HELP imageregistry_http_in_flight_requests A gauge of requests currently being served by the registry.
TYPE imageregistry_http_in_flight_requests gauge
HELP imageregistry_http_request_duration_seconds A histogram of latencies for requests to the registry.
TYPE imageregistry_http_request_duration_seconds summary

$ curl --insecure -s -u <user>:<secret> \


    https://image-registry.openshift-image-registry.svc:5000/extensions/v2/metrics | grep imageregistry | head -n 20
# HELP imageregistry_build_info A metric with a constant '1' value labeled by major, minor, git commit & git version from which the image registry was built.
# TYPE imageregistry_build_info gauge
imageregistry_build_info{gitCommit="9f72191",gitVersion="v3.11.0+9f72191-135-dirty",major="3",minor="11+"} 1
# HELP imageregistry_digest_cache_requests_total Total number of requests without scope to the digest cache.
# TYPE imageregistry_digest_cache_requests_total counter
imageregistry_digest_cache_requests_total{type="Hit"} 5
imageregistry_digest_cache_requests_total{type="Miss"} 24
# HELP imageregistry_digest_cache_scoped_requests_total Total number of scoped requests to the digest cache.
# TYPE imageregistry_digest_cache_scoped_requests_total counter
imageregistry_digest_cache_scoped_requests_total{type="Hit"} 33
imageregistry_digest_cache_scoped_requests_total{type="Miss"} 44
# HELP imageregistry_http_in_flight_requests A gauge of requests currently being served by the registry.
# TYPE imageregistry_http_in_flight_requests gauge
imageregistry_http_in_flight_requests 1
# HELP imageregistry_http_request_duration_seconds A histogram of latencies for requests to the registry.
# TYPE imageregistry_http_request_duration_seconds summary
imageregistry_http_request_duration_seconds{method="get",quantile="0.5"} 0.01296087
imageregistry_http_request_duration_seconds{method="get",quantile="0.9"} 0.014847248
imageregistry_http_request_duration_seconds{method="get",quantile="0.99"} 0.015981195
imageregistry_http_request_duration_seconds_sum{method="get"} 12.260727916000022

Copy to Clipboard

Toggle word wrap

1: <user> can be arbitrary, but <secret> must match the value specified in the registry configuration.

Cluster role

Create a cluster role if you do not already have one to access the metrics:

cat <<EOF |
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: prometheus-scraper
rules:
- apiGroups:
  - image.openshift.io
  resources:
  - registry/metrics
  verbs:
  - get
EOF
oc create -f -

$ cat <<EOF |
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: prometheus-scraper
rules:
- apiGroups:
  - image.openshift.io
  resources:
  - registry/metrics
  verbs:
  - get
EOF
$ oc create -f -

Copy to Clipboard

Toggle word wrap

Add this role to a user, run the following command:

oc adm policy add-cluster-role-to-user prometheus-scraper <username>

$ oc adm policy add-cluster-role-to-user prometheus-scraper <username>

Copy to Clipboard

Toggle word wrap

Access the metrics using cluster role. The part of the configuration file responsible for metrics should look like this:
```
openshift:
  version: 1.0
  metrics:
    enabled: true
...
```
```
openshift:
  version: 1.0
  metrics:
    enabled: true
...
```
Copy to Clipboard Toggle word wrap

Additional resources

A kubeadmin can access the registry until deleted. See Removing the kubeadmin user for more information.
For more information on configuring an identity provider, see Understanding identity provider configuration.

トップに戻る

5.4. Accessing registry metrics

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links