Prometheus Pushgateway: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(16 intermediate revisions by the same user not shown)
Line 8: Line 8:
=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}}
=Sending Metrics=
{{External|https://github.com/prometheus/pushgateway#command-line}}


=Installation=
Metrics are pushed into the gateway by sending a POST request to:
==Kubernetes==
<syntaxhighlight lang='text'>
Deploy the pod and associated services:
http://<gateway-host>:<gateway-port>/metrics/job/<job-name>/instance/<instance-name>
<syntaxhighlight lang='yaml'>
</syntaxhighlight>
apiVersion: v1
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
kind: Pod
The simplest possible body of the POST request could be:
metadata:
<syntaxhighlight lang='text'>
  name: 'pushgateway'
<metric_name> <metric_value>
  labels:
</syntaxhighlight>
    function: 'pushgateway'
Example:
spec:
<syntaxhighlight lang='text'>
  containers:
some_metric 12.5
  - name: 'pushgateway'
</syntaxhighlight>
    image: prom/pushgateway
As such,
---
<syntaxhighlight lang='text'>
apiVersion: v1
echo "some_metric 1.2" | curl --data-binary @- http://localhost:9091/metrics/job/test-job/instance/test-instance
kind: Service
</syntaxhighlight>
metadata:
will produce:
  name: 'pushgateway'
<syntaxhighlight lang='text'>
  labels:
some_metric{instance="test-instance",job="test-job"} 1.2
    function: 'pushgateway-target'
</syntaxhighlight>
spec:
and
  type: 'ClusterIP'
<syntaxhighlight lang='text'>
  selector:
echo "some_other_metric 1.3" | curl --data-binary @- http://localhost:9091/metrics/job/other-test-job
    function: 'pushgateway'
</syntaxhighlight>
  ports:
will produce:
    # 'name' is important, it will be referred by ServiceMonitor configuration
<syntaxhighlight lang='text'>
    - name: 'pushgateway'
some_other_metric{instance="",job="other-test-job"} 1.3
      protocol: 'TCP'
</syntaxhighlight>
      port: 9091
Multiple metrics with additional labels can be sent as such:
      targetPort: 9091
<syntaxhighlight lang='bash'>
---
cat <<EOF | curl --data-binary @- http://localhost:9091/metrics/job/test-job/instance/test-instance
apiVersion: v1
some_metric{color="blue",size="large"} 12.1
kind: Service
some_other_metric{color="green"} 12.2
metadata:
EOF
  name: 'pushgateway-lb'
</syntaxhighlight>
spec:
Alternatively, additional label name and values can be specified in the URL:
  type: 'LoadBalancer'
<syntaxhighlight lang='bash'>
  selector:
echo "some_metric 12.3" | curl --data-binary @- http://localhost:9091/metrics/job/test-job/instance/test-instance/color/blue/size/large
    function: 'pushgateway'
  ports:
    - name: 'pushgateway'
      protocol: 'TCP'
      port: 9091
      targetPort: 9091
</syntaxhighlight>
</syntaxhighlight>
Expose it then as a Prometheus scraping [[Prometheus_Concepts#Target|target]] with a [[Prometheus_Operator_Concepts#ServiceMonitor_Resource|ServiceMonitor]]:
=Storing Metrics=
<syntaxhighlight lang='yaml'>
Upon receipt, Prometheus add extra labels, converting the job and instance in "exported_job" and "exported_instance":
apiVersion: monitoring.coreos.com/v1
<syntaxhighlight lang='bash'>
kind: ServiceMonitor
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"}
metadata:
  name: pushgateway
  namespace: prometheus
  labels:
    release: prometheus
spec:
  endpoints:
  - port: 'pushgateway' # must match the label from Service declaration
    path: /metrics
    interval: 15s
  namespaceSelector:
    matchNames:
    - prometheus
  selector:
    matchLabels:
      function: 'pushgateway-target'
</syntaxhighlight>
</syntaxhighlight>
Also see: {{Internal|Configuring_Prometheus_with_Prometheus_Operator#Add_a_Monitoring_Target|Configuring Prometheus with Prometheus Operator &#124; Add a Monitoring Target}}


=Playground=
=Playground=
Line 93: Line 75:
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==

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"