Skip to content
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.

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

add otel telemetry doc #10977

Merged
merged 7 commits into from
Mar 15, 2022
Merged

add otel telemetry doc #10977

merged 7 commits into from
Mar 15, 2022

Conversation

zirain
Copy link
Member

@zirain zirain commented Feb 26, 2022

Please provide a description for what this PR is for.

add otel telemetry doc

@istio-testing istio-testing added the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label Feb 26, 2022
@istio-testing istio-testing added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 26, 2022
@istio-testing
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@zirain zirain force-pushed the otel-logging branch 3 times, most recently from 11d5c90 to 88aa254 Compare February 27, 2022 11:36
@zirain
Copy link
Member Author

zirain commented Feb 27, 2022

/test all

@zirain zirain marked this pull request as ready for review March 1, 2022 00:23
@zirain zirain requested review from a team as code owners March 1, 2022 00:23
@istio-testing istio-testing removed the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label Mar 1, 2022
Copy link
Contributor

@douglas-reid douglas-reid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good. Mostly nits. Thanks for tackling this!

@zirain
Copy link
Member Author

zirain commented Mar 5, 2022

/test doc.test.profile_default_istio.io

@craigbox
Copy link
Contributor

craigbox commented Mar 7, 2022

Let me know if this is good to go and I can approve.

@zirain
Copy link
Member Author

zirain commented Mar 7, 2022

Let me know if this is good to go and I can approve.

there's something with the test part I need to confirm with @douglas-reid , I'll ping you once it's ready to go.
thanks again.

@zirain
Copy link
Member Author

zirain commented Mar 9, 2022

/test doc.test.profile_demo_istio.io

1 similar comment
@ericvn
Copy link
Contributor

ericvn commented Mar 9, 2022

/test doc.test.profile_demo_istio.io

@ericvn
Copy link
Contributor

ericvn commented Mar 9, 2022

received:
"2022-03-09T12:35:01.500Z	info	builder/receivers_builder.go:68	Receiver is starting...	{"kind": "receiver", "name": "otlp"}
2022-03-09T12:35:01.500Z	info	otlpreceiver/otlp.go:68	Starting GRPC server on endpoint 0.0.0.0:4317	{"kind": "receiver", "name": "otlp"}
2022-03-09T12:35:01.500Z	info	otlpreceiver/otlp.go:86	Starting HTTP server on endpoint 0.0.0.0:4318	{"kind": "receiver", "name": "otlp"}
2022-03-09T12:35:01.500Z	info	otlpreceiver/otlp.go:141	Setting up a second HTTP listener on legacy endpoint 0.0.0.0:55681	{"kind": "receiver", "name": "otlp"}
2022-03-09T12:35:01.500Z	info	otlpreceiver/otlp.go:86	Starting HTTP server on endpoint 0.0.0.0:55681	{"kind": "receiver", "name": "otlp"}
2022-03-09T12:35:01.501Z	info	builder/receivers_builder.go:73	Receiver started.	{"kind": "receiver", "name": "otlp"}
2022-03-09T12:35:01.501Z	info	service/telemetry.go:92	Setting up own telemetry...
2022-03-09T12:35:01.505Z	info	service/telemetry.go:116	Serving Prometheus metrics	{"address": ":8888", "level": "basic", "service.instance.id": "ae125cf2-d80b-4252-8a1f-84d407065909", "service.version": "latest"}
2022-03-09T12:35:01.505Z	info	service/collector.go:230	Starting otelcol...	{"Version": "0.38.0", "NumCPU": 16}
2022-03-09T12:35:01.505Z	info	service/collector.go:132	Everything is ready. Begin running and processing data."
expected:
"outbound|8000||httpbin.default.svc.cluster.local"

@zirain
Copy link
Member Author

zirain commented Mar 10, 2022

/test doc.test.profile_demo_istio.io

1 similar comment
@zirain
Copy link
Member Author

zirain commented Mar 10, 2022

/test doc.test.profile_demo_istio.io

@zirain zirain force-pushed the otel-logging branch 2 times, most recently from 43087f8 to d10ef1a Compare March 10, 2022 10:34
@zirain zirain force-pushed the otel-logging branch 2 times, most recently from ee4accf to f8632d6 Compare March 11, 2022 03:32
@zirain
Copy link
Member Author

zirain commented Mar 11, 2022

@douglas-reid @ericvn fixed the test.sh PTAL.

\"%REQ(:AUTHORITY)%\" \"%UPSTREAM_HOST%\" %UPSTREAM_CLUSTER% %UPSTREAM_LOCAL_ADDRESS% %DOWNSTREAM_LOCAL_ADDRESS% %DOWNSTREAM_REMOTE_ADDRESS% %REQUESTED_SERVER_NAME% %ROUTE_NAME%\n
{{< /text >}}

The following table shows an example using the default access log format for a request sent from `sleep` to `httpbin`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On my computer, this table is very wide and overwrites the right hand column.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than the table, this LGTM.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than the table, this LGTM.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this table come from another page, and I do not change anything, I have no idea about what's happen on your compute.
can we merged this first, let's see what happen to https://preliminary.istio.io/?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://deploy-preview-10977--preliminary-istio.netlify.app/latest/docs/tasks/observability/logs/otel-provider/

I'm OK with merging it and fixing the rendering bug separately. (I don't think you've done anything wrong.)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the page looks good.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's an example on what I see. As Craig mentioned, we can fix this rendering later.
Screen Shot 2022-03-15 at 7 57 12 AM

Copy link
Member Author

@zirain zirain Mar 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there's same issue on page https://istio.io/latest/docs/tasks/observability/logs/access-log/
let's merge this PR first? I will fix them both later this week.

@istio-testing istio-testing merged commit 7a90100 into istio:master Mar 15, 2022
@craigbox
Copy link
Contributor

Is it possible to cherrypick this into 1.13 to get the doc live now, or does it depend on package changes in master?

@ericvn
Copy link
Contributor

ericvn commented Mar 15, 2022

The sample exists in 1.13. Let's give it a try.

@ericvn
Copy link
Contributor

ericvn commented Mar 15, 2022

/cherry-pick release-1.13

@istio-testing
Copy link
Contributor

@ericvn: new pull request created: #11058

In response to this:

/cherry-pick release-1.13

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.

@zirain zirain deleted the otel-logging branch March 16, 2022 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/extensions and telemetry kind/docs size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants