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 /debug/trace/{traceID} endpoint #204

Merged
merged 4 commits into from
Jan 19, 2021
Merged

Conversation

MikeGoldsmith
Copy link
Contributor

@MikeGoldsmith MikeGoldsmith commented Jan 13, 2021

Add a diagnostics HTTP GET endpoint that returns the debug trace information, including the assigned node address using the configured sharding algorithm.

The endpoint can be called like this:
http://localhost:9000/debug/trace/123abc

The response is a JSON object two two properties and looks like the following:
{"traceID":"123abc","node":"http://localhost:12345"}

@MikeGoldsmith MikeGoldsmith requested review from a team and asdvalenzuela January 13, 2021 13:54
route/route.go Outdated Show resolved Hide resolved
Copy link
Contributor

@vreynolds vreynolds left a comment

Choose a reason for hiding this comment

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

Looks good! Is there any security considerations here with exposing a hostname on a non-authed endpoint? I'm assuming it's information that's already public.

@maplebed
Copy link
Contributor

@MikeGoldsmith
Copy link
Contributor Author

Looks good! Is there any security considerations here with exposing a hostname on a non-authed endpoint? I'm assuming it's information that's already public.

Currently Refinery is expected to only work within a secure network and doesn't setup any authentication credentials so I think we're good for now. If we decide to add authentication later, this endpoint should be secured too.

@MikeGoldsmith MikeGoldsmith changed the title Add getNode endpoint to get node address for trace ID Add /debug/trace/{traceID} endpoint Jan 14, 2021
Copy link
Contributor

@vreynolds vreynolds left a comment

Choose a reason for hiding this comment

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

@MikeGoldsmith MikeGoldsmith merged commit becd6a2 into main Jan 19, 2021
@MikeGoldsmith MikeGoldsmith deleted the mike/getnode-endpoint branch January 19, 2021 16:12
MikeGoldsmith added a commit that referenced this pull request Jan 22, 2021
* main:
  Add /debug/trace/{traceID} endpoint (#204)

# Conflicts:
#	route/route_test.go
ghost pushed a commit to opsramp/tracing-proxy that referenced this pull request Jul 5, 2024
Add a diagnostics HTTP GET endpoint that returns the debug trace information, including the assigned node address using the configured sharding algorithm.

The endpoint can be called like this:
http://localhost:9000/debug/trace/123abc

The response is a JSON object two two properties and looks like the following:
{"traceID":"123abc","node":"http://localhost:12345"}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants