Skip to content

Fix documentation for push and pushAdd methods. #137

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

Closed
rohitagarwal003 wants to merge 1 commit into from
Closed

Fix documentation for push and pushAdd methods. #137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 12 additions & 16 deletions simpleclient_pushgateway/src/main/java/io/prometheus/client/exporter/PushGateway.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public PushGateway(String address) {
}

/**
* Pushes all metrics in a registry, replacing all those with the same job as the grouping key.
* Pushes all metrics in a registry, replacing only previously pushed metrics of the same name and job and no grouping key.
* <p>
* This uses the POST HTTP method.
*/
Expand All @@ -75,7 +75,7 @@ public void push(CollectorRegistry registry, String job) throws IOException {
}

/**
* Pushes all metrics in a Collector, replacing all those with the same job and no grouping key.
* Pushes all metrics in a Collector, replacing only previously pushed metrics of the same name and job and no grouping key.
* <p>
* This is useful for pushing a single Gauge.
* <p>
Expand All @@ -88,9 +88,7 @@ public void push(Collector collector, String job) throws IOException {
}

/**
* Pushes all metrics in a Collector, replacing all those with the same job and grouping key.
* <p>
* This is useful for pushing a single Gauge.
* Pushes all metrics in a registry, replacing only previously pushed metrics of the same name, job and grouping key.
* <p>
* This uses the POST HTTP method.
*/
Expand All @@ -99,7 +97,7 @@ public void push(CollectorRegistry registry, String job, Map<String, String> gro
}

/**
* Pushes all metrics in a Collector, replacing all those with the same job and grouping key.
* Pushes all metrics in a Collector, replacing only previously pushed metrics of the same name, job and grouping key.
* <p>
* This is useful for pushing a single Gauge.
* <p>
Expand All @@ -112,7 +110,7 @@ public void push(Collector collector, String job, Map<String, String> groupingKe
}

/**
* Pushes all metrics in a registry, replacing only previously pushed metrics of the same name and job and no grouping key.
* Pushes all metrics in a registry, replacing all those with the same job and no grouping key.
* <p>
* This uses the PUT HTTP method.
*/
Expand All @@ -121,7 +119,7 @@ public void pushAdd(CollectorRegistry registry, String job) throws IOException {
}

/**
* Pushes all metrics in a Collector, replacing only previously pushed metrics of the same name and job and no grouping key.
* Pushes all metrics in a Collector, replacing all those with the same job and no grouping key.
* <p>
* This is useful for pushing a single Gauge.
* <p>
Expand All @@ -134,9 +132,7 @@ public void pushAdd(Collector collector, String job) throws IOException {
}

/**
* Pushes all metrics in a Collector, replacing only previously pushed metrics of the same name, job and grouping key.
* <p>
* This is useful for pushing a single Gauge.
* Pushes all metrics in a registry, replacing all those with the same job and grouping key.
* <p>
* This uses the PUT HTTP method.
*/
Expand All @@ -145,7 +141,7 @@ public void pushAdd(CollectorRegistry registry, String job, Map<String, String>
}

/**
* Pushes all metrics in a Collector, replacing only previously pushed metrics of the same name, job and grouping key.
* Pushes all metrics in a Collector, replacing all those with the same job and grouping key.
* <p>
* This is useful for pushing a single Gauge.
* <p>
Expand Down Expand Up @@ -180,7 +176,7 @@ public void delete(String job, Map<String, String> groupingKey) throws IOExcepti


/**
* Pushes all metrics in a registry, replacing all those with the same job and instance.
* Pushes all metrics in a registry, replacing only previously pushed metrics of the same name.
* <p>
* This uses the POST HTTP method.
* @deprecated use {@link #push(CollectorRegistry, String, Map)}
Expand All @@ -191,7 +187,7 @@ public void push(CollectorRegistry registry, String job, String instance) throws
}

/**
* Pushes all metrics in a Collector, replacing all those with the same job and instance.
* Pushes all metrics in a Collector, replacing only previously pushed metrics of the same name.
* <p>
* This is useful for pushing a single Gauge.
* <p>
Expand All @@ -204,7 +200,7 @@ public void push(Collector collector, String job, String instance) throws IOExce
}

/**
* Pushes all metrics in a registry, replacing only previously pushed metrics of the same name.
* Pushes all metrics in a registry, replacing all those with the same job and instance.
* <p>
* This uses the PUT HTTP method.
* @deprecated use {@link #pushAdd(CollectorRegistry, String, Map)}
Expand All @@ -215,7 +211,7 @@ public void pushAdd(CollectorRegistry registry, String job, String instance) thr
}

/**
* Pushes all metrics in a Collector, replacing only previously pushed metrics of the same name.
* Pushes all metrics in a Collector, replacing all those with the same job and instance.
* <p>
* This is useful for pushing a single Gauge.
* <p>
Expand Down