Correct telemetry for Prometheus doc #2866

clyang82 · 2018-11-13T05:18:35Z

Signed-off-by: Chun Lin Yang [email protected]

Make the document (https://preliminary.istio.io/docs/tasks/telemetry/querying-metrics/) changes to reflect - istio/istio#8415

istio-testing · 2018-11-13T05:18:50Z

Hi @clyang82. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

clyang82 · 2018-11-13T05:19:16Z

/ @douglas-reid is my understanding right? please review. Thanks.

douglas-reid

Thanks so much for tackling this item! I had a few nits/suggestions, but this is great.

douglas-reid · 2018-11-13T16:10:53Z

content/docs/tasks/telemetry/querying-metrics/index.md

   to monitor Mixer itself.
-1. *envoy* (`istio-mixer.istio-system:9102`): raw stats generated by Envoy (and
-   translated from Statsd to Prometheus).
+1. *envoy* (`istio-proxy:15090`): raw stats generated by Envoy.


while we are here, can we also add entries for pilot, galley, and istio-policy (and update the "The configured Prometheus add-on scrapes three endpoints:" to read "The configured Prometheus add-on scrapes the following endpoints:") ?

douglas-reid · 2018-11-13T16:13:43Z

content/docs/tasks/telemetry/querying-metrics/index.md


-For more on querying Prometheus, please read their [querying
+Prometheus configures to look for pods with the endpoint exposed and filters out a large number of envoy metrics based on scraping configuration. For more on querying Prometheus, please read their [querying


nit: "Prometheus is configured to look for pods with the envoy-prom endpoint exposed. The add-on configuration filters out a large number of envoy metrics during collection in an attempt to limit the scale of data processed by the add-on."

clyang82 · 2018-11-14T05:23:31Z

@douglas-reid Thanks for your suggestions. I have updated accordingly. I have one question about Prometheus? there are some configurations to define how to scrape the data. this is prometheus pull mode. In mixer adapter, there is a prometheus adapter which is using push mode. Is my understanding right? What is the difference in istio for these 2 modes? Thanks.

rcaballeromx

Do not use parenthesis; they are ambiguous in their meaning. Instead use verbs and prepositions to make the actions the reader can take and the results of those actions clear.

rcaballeromx · 2018-11-20T17:12:52Z

content/docs/tasks/telemetry/querying-metrics/index.md


-1. *istio-mesh* (`istio-mixer.istio-system:42422`): all Mixer-generated mesh
+1. *istio-mesh* (`istio-telemetry.istio-system:42422`): all Mixer-generated mesh


Why are these not capitalized and separated. Is that the actual value of the endpoint? That case seems unlikely since I see the actual code in the parenthesis. Please capitalize appropriately and write them as separate words. Please use verbs and prepositions to make the actions explicit:

Suggested change

1. *istio-mesh* (`istio-telemetry.istio-system:42422`): all Mixer-generated mesh

1. **Istio mesh** addressable at `istio-telemetry.istio-system:42422`: Returns all Mixer-generated mesh

@rcaballeromx Thanks for your suggestions. actually, they are job names configured in prometheus. refer this document - https://preliminary.istio.io/help/ops/telemetry/missing-metrics/#verify-prometheus-configuration , you can find the job name

Then, please refer to them as jobs and link to that page in your content. For example: The istio-mesh job ...

@rcaballeromx The page is used to tell the user how to verify the prometheus configurations. I do not think it is proper to link that here. How about change to - istio-telemetry.istio-system:42422: The istio-mesh job returns all Mixer-generated mesh

rcaballeromx · 2018-11-20T17:14:03Z

content/docs/tasks/telemetry/querying-metrics/index.md

   metrics.
-1. *mixer* (`istio-mixer.istio-system:9093`): all Mixer-specific metrics. Used
+1. *istio-telemetry* (`istio-telemetry.istio-system:9093`): all Mixer-specific metrics. Used


See my comment on line 96:

Suggested change

1. *istio-telemetry* (`istio-telemetry.istio-system:9093`): all Mixer-specific metrics. Used

1. **Istio telemetry** addressable at `istio-telemetry.istio-system:9093`: Returns all Mixer-specific metrics. Use this endpoint

rcaballeromx · 2018-11-20T17:16:50Z

content/docs/tasks/telemetry/querying-metrics/index.md

   to monitor Mixer itself.
-1. *envoy* (`istio-mixer.istio-system:9102`): raw stats generated by Envoy (and
-   translated from Statsd to Prometheus).
+1. *envoy-stats* (`istio-proxy:15090`): raw stats generated by Envoy. Prometheus is configured to look for pods with the `envoy-prom` endpoint exposed. The add-on configuration filters out a large number of envoy metrics during collection in an attempt to limit the scale of data processed by the add-on.


See my comment on line 96:

Suggested change

1. *envoy-stats* (`istio-proxy:15090`): raw stats generated by Envoy. Prometheus is configured to look for pods with the `envoy-prom` endpoint exposed. The add-on configuration filters out a large number of envoy metrics during collection in an attempt to limit the scale of data processed by the add-on.

1. Envoy stats addressable at `istio-proxy:15090`: Returns the raw stats generated by Envoy. Prometheus is configured to look for pods with the `envoy-prom` endpoint exposed. The add-on configuration filters out a large number of envoy metrics during collection in an attempt to limit the scale of data the add-on processes.

rcaballeromx · 2018-11-20T17:32:42Z

content/docs/tasks/telemetry/querying-metrics/index.md

-1. *envoy* (`istio-mixer.istio-system:9102`): raw stats generated by Envoy (and
-   translated from Statsd to Prometheus).
+1. *envoy-stats* (`istio-proxy:15090`): raw stats generated by Envoy. Prometheus is configured to look for pods with the `envoy-prom` endpoint exposed. The add-on configuration filters out a large number of envoy metrics during collection in an attempt to limit the scale of data processed by the add-on.
+1. *pilot* (`istio-pilot.istio-system:9093`): all pilot metrics.


Suggested change

1. *pilot* (`istio-pilot.istio-system:9093`): all pilot metrics.

1. **Pilot** addressable at`istio-pilot.istio-system:9093`: Returns all the Pilot-generated metrics.

rcaballeromx · 2018-11-20T17:33:25Z

content/docs/tasks/telemetry/querying-metrics/index.md

-   translated from Statsd to Prometheus).
+1. *envoy-stats* (`istio-proxy:15090`): raw stats generated by Envoy. Prometheus is configured to look for pods with the `envoy-prom` endpoint exposed. The add-on configuration filters out a large number of envoy metrics during collection in an attempt to limit the scale of data processed by the add-on.
+1. *pilot* (`istio-pilot.istio-system:9093`): all pilot metrics.
+1. *galley* (`istio-galley.istio-system:9093`): all galley metrics.


Suggested change

1. *galley* (`istio-galley.istio-system:9093`): all galley metrics.

1. **Galley** addressable at `istio-galley.istio-system:9093`: Returns all the Galley-generated metrics.

rcaballeromx · 2018-11-20T17:34:14Z

content/docs/tasks/telemetry/querying-metrics/index.md

+1. *envoy-stats* (`istio-proxy:15090`): raw stats generated by Envoy. Prometheus is configured to look for pods with the `envoy-prom` endpoint exposed. The add-on configuration filters out a large number of envoy metrics during collection in an attempt to limit the scale of data processed by the add-on.
+1. *pilot* (`istio-pilot.istio-system:9093`): all pilot metrics.
+1. *galley* (`istio-galley.istio-system:9093`): all galley metrics.
+1. *istio-policy* (`istio-policy.istio-system:9093`): all policy metrics.


Suggested change

1. *istio-policy* (`istio-policy.istio-system:9093`): all policy metrics.

1. **Istio policy** addressable at `istio-policy.istio-system:9093`: Returns all policy-related metrics.

geeknoid · 2018-12-17T23:16:39Z

Can we move this forward? Only a few grammatical fixes left...

Thanks.

Signed-off-by: Chun Lin Yang <[email protected]>

geeknoid · 2018-12-18T15:00:42Z

content/docs/tasks/telemetry/querying-metrics/index.md

-   translated from Statsd to Prometheus).
+The configured Prometheus add-on scrapes the following endpoints:
+
+1. `istio-telemetry.istio-system:42422`: The `istio-mesh` job returns all Mixer-generated mesh.


mesh metrics

Signed-off-by: Chun Lin Yang <[email protected]>

gyliu513 · 2018-12-19T03:37:44Z

/lgtm

istio-testing · 2018-12-19T03:37:50Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: clyang82, gyliu513
To fully approve this pull request, please assign additional approvers.
We suggest the following additional approver: rcaballeromx

If they are not already assigned, you can assign the PR to them by writing /assign @rcaballeromx in a comment when ready.

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

content/OWNERS
~~content_zh/OWNERS~~ [gyliu513]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* Correct telemetry for prometheus doc Signed-off-by: Chun Lin Yang <[email protected]> * Add galley,polit and policy Signed-off-by: Chun Lin Yang <[email protected]> * update zh doc Signed-off-by: Chun Lin Yang <[email protected]> * Address review comments Signed-off-by: Chun Lin Yang <[email protected]> * mesh to metrics Signed-off-by: Chun Lin Yang <[email protected]>

googlebot added the cla: yes label Nov 13, 2018

istio-testing requested review from gyliu513 and rcaballeromx November 13, 2018 05:18

istio-testing added the needs-ok-to-test label Nov 13, 2018

geeknoid removed needs-ok-to-test labels Nov 13, 2018

geeknoid requested a review from douglas-reid November 13, 2018 16:12

douglas-reid reviewed Nov 13, 2018

View reviewed changes

clyang82 mentioned this pull request Nov 20, 2018

REQUEST: New membership for clyang82 istio/community#102

Closed

7 tasks

rcaballeromx suggested changes Nov 20, 2018

View reviewed changes

geeknoid removed needs-ok-to-test labels Dec 7, 2018

geeknoid removed needs-ok-to-test labels Dec 17, 2018

clyang82 added 4 commits December 18, 2018 11:27

Correct telemetry for prometheus doc

cfb9ccb

Signed-off-by: Chun Lin Yang <[email protected]>

Add galley,polit and policy

89b3a24

Signed-off-by: Chun Lin Yang <[email protected]>

update zh doc

582b4c9

Signed-off-by: Chun Lin Yang <[email protected]>

Address review comments

d03a298

Signed-off-by: Chun Lin Yang <[email protected]>

clyang82 force-pushed the fix_telemetry_prome branch from 9dfc292 to d03a298 Compare December 18, 2018 03:28

geeknoid reviewed Dec 18, 2018

View reviewed changes

mesh to metrics

2b754fc

Signed-off-by: Chun Lin Yang <[email protected]>

istio-testing assigned gyliu513 Dec 19, 2018

istio-testing added the lgtm label Dec 19, 2018

geeknoid removed needs-ok-to-test labels Dec 19, 2018

geeknoid merged commit c0d784e into istio:master Dec 19, 2018

gargnupur mentioned this pull request Dec 20, 2018

Issue with doc /docs/tasks/telemetry/querying-metrics/ #2955

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Correct telemetry for Prometheus doc #2866

Correct telemetry for Prometheus doc #2866

clyang82 commented Nov 13, 2018 •

edited

Loading

istio-testing commented Nov 13, 2018

clyang82 commented Nov 13, 2018

douglas-reid left a comment

douglas-reid Nov 13, 2018

clyang82 Nov 14, 2018

douglas-reid Nov 13, 2018

clyang82 Nov 14, 2018

clyang82 commented Nov 14, 2018

rcaballeromx left a comment

rcaballeromx Nov 20, 2018

clyang82 Nov 21, 2018

rcaballeromx Nov 26, 2018

clyang82 Nov 27, 2018 •

edited

Loading

rcaballeromx Nov 20, 2018

rcaballeromx Nov 20, 2018

rcaballeromx Nov 20, 2018

rcaballeromx Nov 20, 2018

rcaballeromx Nov 20, 2018

geeknoid commented Dec 17, 2018

geeknoid Dec 18, 2018

clyang82 Dec 19, 2018

gyliu513 commented Dec 19, 2018

istio-testing commented Dec 19, 2018


		For more on querying Prometheus, please read their [querying
		Prometheus configures to look for pods with the endpoint exposed and filters out a large number of envoy metrics based on scraping configuration. For more on querying Prometheus, please read their [querying


		1. istio-mesh (`istio-mixer.istio-system:42422`): all Mixer-generated mesh
		1. istio-mesh (`istio-telemetry.istio-system:42422`): all Mixer-generated mesh

	1. istio-mesh (`istio-telemetry.istio-system:42422`): all Mixer-generated mesh
	1. Istio mesh addressable at `istio-telemetry.istio-system:42422`: Returns all Mixer-generated mesh

	1. istio-telemetry (`istio-telemetry.istio-system:9093`): all Mixer-specific metrics. Used
	1. Istio telemetry addressable at `istio-telemetry.istio-system:9093`: Returns all Mixer-specific metrics. Use this endpoint

	1. envoy-stats (`istio-proxy:15090`): raw stats generated by Envoy. Prometheus is configured to look for pods with the `envoy-prom` endpoint exposed. The add-on configuration filters out a large number of envoy metrics during collection in an attempt to limit the scale of data processed by the add-on.
	1. Envoy stats addressable at `istio-proxy:15090`: Returns the raw stats generated by Envoy. Prometheus is configured to look for pods with the `envoy-prom` endpoint exposed. The add-on configuration filters out a large number of envoy metrics during collection in an attempt to limit the scale of data the add-on processes.

	1. pilot (`istio-pilot.istio-system:9093`): all pilot metrics.
	1. Pilot addressable at`istio-pilot.istio-system:9093`: Returns all the Pilot-generated metrics.

	1. galley (`istio-galley.istio-system:9093`): all galley metrics.
	1. Galley addressable at `istio-galley.istio-system:9093`: Returns all the Galley-generated metrics.

	1. istio-policy (`istio-policy.istio-system:9093`): all policy metrics.
	1. Istio policy addressable at `istio-policy.istio-system:9093`: Returns all policy-related metrics.

Correct telemetry for Prometheus doc #2866

Correct telemetry for Prometheus doc #2866

Conversation

clyang82 commented Nov 13, 2018 • edited Loading

istio-testing commented Nov 13, 2018

clyang82 commented Nov 13, 2018

douglas-reid left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clyang82 commented Nov 14, 2018

rcaballeromx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clyang82 Nov 27, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

geeknoid commented Dec 17, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gyliu513 commented Dec 19, 2018

istio-testing commented Dec 19, 2018

clyang82 commented Nov 13, 2018 •

edited

Loading

clyang82 Nov 27, 2018 •

edited

Loading