Prometheus Pushgateway: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(27 intermediate revisions by the same user not shown)
Line 2: Line 2:
* https://prometheus.io/docs/instrumenting/pushing/
* https://prometheus.io/docs/instrumenting/pushing/
* https://github.com/prometheus/pushgateway/blob/master/README.md
* https://github.com/prometheus/pushgateway/blob/master/README.md
* https://www.metricfire.com/blog/prometheus-pushgateways-everything-you-need-to-know/
=Internal=
=Internal=
* [[Prometheus Concepts#Pushgateway|Prometheus Concepts]]
* [[Prometheus Concepts#Pushgateway|Prometheus Concepts]]
=Overview=
=Overview=
Push gateways are used in case of applications or short-lived jobs that do not export metrics directly.
Push gateways are used in case of applications or short-lived jobs that do not export metrics directly.
=Installation=
{{Internal|Prometheus Pushgateway Installation|Installation}}


=Installation=
=Sending Metrics=
==Kubernetes==
{{External|https://github.com/prometheus/pushgateway#command-line}}
<syntaxhighlight lang='yaml'>
 
apiVersion: v1
Metrics are pushed into the gateway by sending a POST request to:
kind: Pod
<syntaxhighlight lang='text'>
metadata:
http://<gateway-host>:<gateway-port>/metrics/job/<job-name>/instance/<instance-name>
  name: 'pushgateway'
</syntaxhighlight>
  labels:
The job name and instance name are attached as metadata to the sample, as values for the labels "[[Prometheus_Concepts#Job|job]]" and "[[Prometheus_Concepts#Instance|instance]]". At least the job name must be specified. If the instance name is not specified, it will default to the empty string
    function: 'pushgateway'
The simplest possible body of the POST request could be:
spec:
<syntaxhighlight lang='text'>
  containers:
<metric_name> <metric_value>
  - name: 'pushgateway'
</syntaxhighlight>
    image: prom/pushgateway
Example:
---
<syntaxhighlight lang='text'>
apiVersion: v1
some_metric 12.5
kind: Service
</syntaxhighlight>
metadata:
As such,
  name: 'pushgateway'
<syntaxhighlight lang='text'>
  labels:
echo "some_metric 1.2" | curl --data-binary @- http://localhost:9091/metrics/job/test-job/instance/test-instance
    function: 'prometheus-target'
</syntaxhighlight>
spec:
will produce:
  type: 'ClusterIP'
<syntaxhighlight lang='text'>
  selector:
some_metric{instance="test-instance",job="test-job"} 1.2
    function: 'pushgateway'
</syntaxhighlight>
  ports:
and
    - name: 'pushgateway'
<syntaxhighlight lang='text'>
      protocol: 'TCP'
echo "some_other_metric 1.3" | curl --data-binary @- http://localhost:9091/metrics/job/other-test-job
      port: 9091
</syntaxhighlight>
      targetPort: 9091
will produce:
---
<syntaxhighlight lang='text'>
apiVersion: v1
some_other_metric{instance="",job="other-test-job"} 1.3
kind: Service
</syntaxhighlight>
metadata:
Multiple metrics with additional labels can be sent as such:
  name: 'pushgateway-lb'
<syntaxhighlight lang='bash'>
spec:
cat <<EOF | curl --data-binary @- http://localhost:9091/metrics/job/test-job/instance/test-instance
  type: 'LoadBalancer'
some_metric{color="blue",size="large"} 12.1
  selector:
some_other_metric{color="green"} 12.2
    function: 'pushgateway'
EOF
  ports:
</syntaxhighlight>
    - name: 'pushgateway'
Alternatively, additional label name and values can be specified in the URL:
      protocol: 'TCP'
<syntaxhighlight lang='bash'>
      port: 9091
echo "some_metric 12.3" | curl --data-binary @- http://localhost:9091/metrics/job/test-job/instance/test-instance/color/blue/size/large
      targetPort: 9091
</syntaxhighlight>
=Storing Metrics=
Upon receipt, Prometheus add extra labels, converting the job and instance in "exported_job" and "exported_instance":
<syntaxhighlight lang='bash'>
action_queue_depth{exported_job="test-job",exported_instance="test-instance",job="pushgateway",instance="10.1.0.33:9091",endpoint="pushgateway",namespace="prometheus",pod="pushgateway",service="pushgateway"}
</syntaxhighlight>
</syntaxhighlight>


Line 60: Line 68:
echo "some_metric 3.14" | curl --data-binary @- http://localhost:9091/metrics/job/some_job
echo "some_metric 3.14" | curl --data-binary @- http://localhost:9091/metrics/job/some_job
</syntaxhighlight>
</syntaxhighlight>
==Console==
http://localhost:9091/
==Query Metrics==
==Query Metrics==
Do not use trailing slash otherwise you'll get "Moved Permanently":
<syntaxhighlight lang='bash'>
<syntaxhighlight lang='bash'>
curl http://localhost:9091/metrics/
curl http://localhost:9091/metrics
</syntaxhighlight>
</syntaxhighlight>
The result is the last sample for each timeseries.
==Query Health==
==Query Health==
<syntaxhighlight lang='bash'>
<syntaxhighlight lang='bash'>
Line 72: Line 85:
curl http://localhost:9091/-/ready
curl http://localhost:9091/-/ready
</syntaxhighlight>
</syntaxhighlight>
==Configure Pushgateway as a Prometheus Target==

Latest revision as of 03:23, 16 October 2020

External

Internal

Overview

Push gateways are used in case of applications or short-lived jobs that do not export metrics directly.

Installation

Installation

Sending Metrics

https://github.com/prometheus/pushgateway#command-line

Metrics are pushed into the gateway by sending a POST request to: 

http://<gateway-host>:<gateway-port>/metrics/job/<job-name>/instance/<instance-name>

The job name and instance name are attached as metadata to the sample, as values for the labels "job" and "instance". At least the job name must be specified. If the instance name is not specified, it will default to the empty string The simplest possible body of the POST request could be: 

<metric_name> <metric_value>

Example: 

some_metric 12.5

As such, 

echo "some_metric 1.2" | curl --data-binary @- http://localhost:9091/metrics/job/test-job/instance/test-instance

will produce: 

some_metric{instance="test-instance",job="test-job"} 1.2

and 

echo "some_other_metric 1.3" | curl --data-binary @- http://localhost:9091/metrics/job/other-test-job

will produce: 

some_other_metric{instance="",job="other-test-job"} 1.3

Multiple metrics with additional labels can be sent as such: 

cat <<EOF | curl --data-binary @- http://localhost:9091/metrics/job/test-job/instance/test-instance
some_metric{color="blue",size="large"} 12.1
some_other_metric{color="green"} 12.2
EOF

Alternatively, additional label name and values can be specified in the URL: 

echo "some_metric 12.3" | curl --data-binary @- http://localhost:9091/metrics/job/test-job/instance/test-instance/color/blue/size/large

Storing Metrics

Upon receipt, Prometheus add extra labels, converting the job and instance in "exported_job" and "exported_instance": 

action_queue_depth{exported_job="test-job",exported_instance="test-instance",job="pushgateway",instance="10.1.0.33:9091",endpoint="pushgateway",namespace="prometheus",pod="pushgateway",service="pushgateway"}

Playground

https://github.com/ovidiuf/playground/tree/master/prometheus/pushgateway

Operations

Push a Metric Sample

echo "some_metric 3.14" | curl --data-binary @- http://localhost:9091/metrics/job/some_job

Console

http://localhost:9091/

Query Metrics

Do not use trailing slash otherwise you'll get "Moved Permanently": 

curl http://localhost:9091/metrics

The result is the last sample for each timeseries.

Query Health

curl http://localhost:9091/-/healthy

Query Readiness

curl http://localhost:9091/-/ready
Retrieved from "https://kb.novaordis.com/index.php?title=Prometheus_Pushgateway&oldid=72094"