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.

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

Jump to bottom

[Tools][Docs] Add instructions on how to collect the produced telemetry data #31809

Closed
Tracked by #30574
asfimport opened this issue May 2, 2022 · 8 comments · Fixed by #33873
Closed
Tracked by #30574

[Tools][Docs] Add instructions on how to collect the produced telemetry data #31809

asfimport opened this issue May 2, 2022 · 8 comments · Fixed by #33873
Assignees
@amoeba
Labels
Component: Developer Tools Component: Documentation Type: task
Milestone
12.0.0

Comments

@asfimport
Copy link
Collaborator

With the ongoing efforts to produce telemetry data in the engine, it might be helpful to collect some notes from the landed PRs about how to collect the telemetry data using the otel-collector and Jaeger running in some containers with docker-compose.

The goal is to make it trivial with these notes to get started with the telemetry data produced by the engine.

Reporter: Matthijs Brobbel / @mbrobbel
Assignee: Bryce Mecum / @amoeba

Note: This issue was originally created as ARROW-16435. Please see the migration documentation for further details.
@asfimport
Copy link
Collaborator Author

Todd Farmer / @toddfarmer:
This issue was last updated over 90 days ago, which may be an indication it is no longer being actively worked. To better reflect the current state, the issue is being unassigned per project policy. Please feel free to re-take assignment of the issue if it is being actively worked, or if you plan to start that work soon.

@asfimport
Copy link
Collaborator Author

Matthijs Brobbel / @mbrobbel:
It seems there is an ongoing effort by @amoeba to add these instructions to https://github.com/amoeba/arrow-opentelemetry-example.

@asfimport
Copy link
Collaborator Author

Bryce Mecum / @amoeba:
Good eye, @mbrobbel. Do you know if the team has discussed an approach to documenting OTel functionality further in the Arrow docs? I think all we have right now is a note about ARROW_TRACING_BACKEND but the rest is left to the user.

@asfimport
Copy link
Collaborator Author

Matthijs Brobbel / @mbrobbel:
I planned on working on this but never got around to doing it. My plan was to add a section to the user guide.

@asfimport
Copy link
Collaborator Author

Bryce Mecum / @amoeba:
If you still had interest and time, I'd be happy to contribute. If not, let me know and I can sketch something out. If I did that, would you have any cycles to help review?

@asfimport
Copy link
Collaborator Author

Matthijs Brobbel / @mbrobbel:
I would be happy to help review.

@asfimport
Copy link
Collaborator Author

Bryce Mecum / @amoeba:
That'd be great, thanks. I'll work something up in December.

@asfimport asfimport mentioned this issue Jan 11, 2023
Open
8 tasks
@amoeba amoeba mentioned this issue Jan 26, 2023
Merged
@amoeba
Copy link
Member

amoeba commented Jan 26, 2023

Hey @mbrobbel, I worked up a first draft in #33873 and would love a review by you or others close to this work.

lidavidm pushed a commit that referenced this issue Feb 7, 2023
@amoeba @mbrobbel
GH-31809: [Docs] Add instructions on how to collect the produced tele…
63cb14e 
…metry data (#33873)

### Rationale for this change

The codebase has been partially implemented with the OpenTelemetry SDK and it would be beneficial for users to have a concise guide on how to get started collecting and visualizing tracing data.

### What changes are included in this PR?

This is an initial draft for review of an addition to the [C++ User Guide](https://arrow.apache.org/docs/dev/cpp/user_guide.html) as mentioned in #31809 (comment).

### Are these changes tested?

These changes have been tested locally by building the docs and verifying.

### Are there any user-facing changes?

Yes, but just documentation changes.
* Closes: #31809

Lead-authored-by: Bryce Mecum <petridish@gmail.com>
Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
@lidavidm lidavidm added this to the 12.0.0 milestone Feb 7, 2023
sjperkins pushed a commit to sjperkins/arrow that referenced this issue Feb 10, 2023
@amoeba @mbrobbel @sjperkins
apacheGH-31809: [Docs] Add instructions on how to collect the produce…
d53d368 
…d telemetry data (apache#33873)

### Rationale for this change

The codebase has been partially implemented with the OpenTelemetry SDK and it would be beneficial for users to have a concise guide on how to get started collecting and visualizing tracing data.

### What changes are included in this PR?

This is an initial draft for review of an addition to the [C++ User Guide](https://arrow.apache.org/docs/dev/cpp/user_guide.html) as mentioned in apache#31809 (comment).

### Are these changes tested?

These changes have been tested locally by building the docs and verifying.

### Are there any user-facing changes?

Yes, but just documentation changes.
* Closes: apache#31809

Lead-authored-by: Bryce Mecum <petridish@gmail.com>
Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
gringasalpastor pushed a commit to gringasalpastor/arrow that referenced this issue Feb 17, 2023
@amoeba @mbrobbel
apacheGH-31809: [Docs] Add instructions on how to collect the produce…
ba790b1 
…d telemetry data (apache#33873)

### Rationale for this change

The codebase has been partially implemented with the OpenTelemetry SDK and it would be beneficial for users to have a concise guide on how to get started collecting and visualizing tracing data.

### What changes are included in this PR?

This is an initial draft for review of an addition to the [C++ User Guide](https://arrow.apache.org/docs/dev/cpp/user_guide.html) as mentioned in apache#31809 (comment).

### Are these changes tested?

These changes have been tested locally by building the docs and verifying.

### Are there any user-facing changes?

Yes, but just documentation changes.
* Closes: apache#31809

Lead-authored-by: Bryce Mecum <petridish@gmail.com>
Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
fatemehp pushed a commit to fatemehp/arrow that referenced this issue Feb 24, 2023
@amoeba @mbrobbel @fatemehp
apacheGH-31809: [Docs] Add instructions on how to collect the produce…
3f2acff 
…d telemetry data (apache#33873)

### Rationale for this change

The codebase has been partially implemented with the OpenTelemetry SDK and it would be beneficial for users to have a concise guide on how to get started collecting and visualizing tracing data.

### What changes are included in this PR?

This is an initial draft for review of an addition to the [C++ User Guide](https://arrow.apache.org/docs/dev/cpp/user_guide.html) as mentioned in apache#31809 (comment).

### Are these changes tested?

These changes have been tested locally by building the docs and verifying.

### Are there any user-facing changes?

Yes, but just documentation changes.
* Closes: apache#31809

Lead-authored-by: Bryce Mecum <petridish@gmail.com>
Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@amoeba amoeba

Labels
Component: Developer Tools Component: Documentation Type: task
Projects
None yet
Milestone
12.0.0
Development

Successfully merging a pull request may close this issue.

GH-31809: [Docs] Add instructions on how to collect the produced telemetry data amoeba/arrow
3 participants
@amoeba @lidavidm @asfimport