-
Notifications
You must be signed in to change notification settings - Fork 360
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 OpenTelemetry Tracing capabilities to Cloud Controller #3774
Open
MarcWoern
wants to merge
2
commits into
cloudfoundry:main
Choose a base branch
from
MarcWoern:open-telemetry-tracing
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FloThinksPi
force-pushed
the
open-telemetry-tracing
branch
3 times, most recently
from
April 30, 2024 14:21
154ba00
to
ed2e135
Compare
This is commit is there just to comply with the Apache2 License, so that modifications will be later visible/traceable. Co-Authored-By: MarcWoern <[email protected]>
FloThinksPi
force-pushed
the
open-telemetry-tracing
branch
2 times, most recently
from
May 2, 2024 14:48
17ced09
to
f9e62f2
Compare
In this change we implement Opentelemetry(OTel) tracing support for the ruby cloud_controller using the official(by OTel community) library opentelemetry-ruby. It enables the cloud_controller itself to measure traces and spans and send them to a OpenTelemetryProtocol(OTLP) capable backend. The recorded root span is stored in the with the service-name "cloud_controller_ng-api" or "cloud_controller_ng-worker". A trace of an api call that starts a delayed_job will cause a link between this api call and the trace of the worker. The worker inherits the sampling decision of the api call too, meaning a sampled api call will also lead to a sampled job run. The service name can be used to find the trace in the attached backend. Job samples and Api samples will have a bidirectional link. When disabled the code that load and initialise the framework as well as the middleware are not used to minimise impact on performance and bug surface. Instrumentations: The opentelemetry-ruby library offers a few out of the box instrumentations which extend key function calls in libraries automatically once loaded and measure span. The used instrumentations and their respective roles include: - HttpClient: This instrumentation tracks outgoing HTTP requests executed with the httpclient gem. - HTTP: This instrumentations traces the HTTP client and server-side libraries. - Mysql2: This instrumentation detects queries, database calls, transactions, etc., made to MySQL using the Mysql2 gem. - Redis: This instrumentation traces all commands sent to Redis server using the redis-rb gem. - Rake: This instrumentation measures the execution time of your Rake tasks. - CCDelayedJob: This instrumentation traces the enqueue/job execute cycle within delayed jobs. This is a modified version of the DelayedJob instrumentation that propagates trace information so that bidirectional links can be set. It also records some cloud_controller specific job attributes when they are available. - PG (Postgres): Postgres instrumentation captures SQL queries executed on a Postgres database. The instrumentations automatically set spans into traces and spans, which are set manually in the code(OpenTelemetryMiddleware) to track specific activities. Manual spans include: - middleware-pre-app: This span measures the middleware before the application runs. - application: This span measures the application runtime(without middleware). Configuration To properly configure this functionality following properties will be introduced: - [otel][tracing][enabled]: Set this to true or false. If it's false, all functionality regarding OpenTelemetry Tracing is disabled. - [otel][tracing][api_url]: Set the URL for the API. - [otel][tracing][api_token]: Set the token for the API - [otel][tracing][redact][db_statemets]: Set this to true or false. If false the full sql statement will be provided as attribute in the spans of the mysql or pg instrumentation. If set to true, it will log the statements but will redact the query parameters as well as insert/update values by question marks. - [otel][tracing][sampling_ratio]: Set a float between 0.0 (=0%) and 1.0 (=100%) to define the probability with that traces are sampled. - [otel][tracing][propagation][accept_sampling_instruction] Set this to true or false. If true, the header passing the sampling value to the cloud_controller will be honoured and make the cloud_controller to also trace. If set to false the tracing information is parsed but it does not influence the sampling decision based on above sampling_ratio. - [otel][tracing][propagation][extractors]: Here you can set the list of propagators to be extracted. Extractors read the HTTP headers provided and deserialize the contained tracing information. - [otel][tracing][propagation][injectors]: Here you can set the list of propagators to be injected. Injectors serialize the tracing information into HTTP headers for propagation. Propagation Propagation refers to the process of moving tracing data using HTTP headers across service boundaries that can be linked together into a single trace. Propagators accepted are: - tracecontext(https://www.w3.org/TR/trace-context/) - baggage(https://www.w3.org/TR/baggage/) - b3(https://github.com/openzipkin/b3-propagation) - b3multi(https://github.com/openzipkin/b3-propagation) - jaeger(https://www.jaegertracing.io/docs/1.56/client-libraries/#propagation-format) - xray(https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html#xray-concepts-tracingheader) - none Propagators can be differentiated into extractors and injectors. Extractors are responsible for extracting trace context from incoming requests(incoming api calls), while injectors are responsible for injecting trace context into outgoing requests(e.g. to UAA or service brokers). If more than one injector is configured in the HTTP Request, than the last propagator that can successfully process the supplied headers defines the inherited trace context, in case multiple conflicting trace headers are recieved. If more than on extractor is configured, the CC will propagate the information in all configured formats. The propagators tracecontext and jaeger also support baggage. With baggage key-value pairs can be added to the headers. If more than one propagation, which supports baggage, is present, the first baggage key-value pairs are being used. The propagation functionality hereby replaces the zipkin middleware wich was removed, since it implemented the propagation(only, without the cloud_controller adding trace data) for the B3Multi Header exclusively. The current implementation with OTel can be configured to offer the exact same functionality/behaviour. Co-Authored-By: FlorianBraun <[email protected]>
FloThinksPi
force-pushed
the
open-telemetry-tracing
branch
from
May 3, 2024 08:37
f9e62f2
to
7d3d56a
Compare
One gap in testing is the self written delayed jobs tracing instrumentation. It could benefit from some serialisation/deserialisation tests as well as tests to set the links and attributes properly. We did run out of time for that, i think for now this can be reviewed for feedback but before merging we should add tests for the instrumentation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this change we implement Opentelemetry(OTel) tracing support for the ruby cloud_controller using the official(by OTel community) library opentelemetry-ruby.
It enables the cloud_controller itself to measure traces and spans and send them to a OpenTelemetryProtocol(OTLP) capable backend.
The recorded root span is stored in the with the service-name "cloud_controller_ng-api" or "cloud_controller_ng-worker".
A trace of an api call that starts a delayed_job will cause a link between this api call and the trace of the worker.
The worker inherits the sampling decision of the api call too, meaning a sampled api call will also lead to a sampled job run.
The service name can be used to find the trace in the attached backend. Job samples and Api samples will have a bidirectional link.
When disabled the code that load and initialise the framework as well as the middleware are not used to minimise impact on performance and bug surface.
Instrumentations:
The opentelemetry-ruby library offers a few out of the box instrumentations which extend key function calls in libraries automatically once loaded and measure span. The used instrumentations and their respective roles include:
The instrumentations automatically set spans into traces and spans, which are set manually in the code(OpenTelemetryMiddleware) to track specific activities. Manual spans include:
Configuration
To properly configure this functionality following properties will be
introduced:
Propagation
Propagation refers to the process of moving tracing data using HTTP headers across service boundaries that can be linked together into a single trace.
Propagators accepted are:
Propagators can be differentiated into extractors and injectors. Extractors are responsible for extracting trace context from incoming requests(incoming api calls), while injectors are responsible for injecting trace context into outgoing requests(e.g. to UAA or service brokers).
If more than one injector is configured in the HTTP Request, than the last propagator that can successfully process the supplied headers defines the inherited trace context, in case multiple conflicting trace headers are recieved.
If more than on extractor is configured, the CC will propagate the information in all configured formats.
The propagators tracecontext and jaeger also support baggage. With baggage key-value pairs can be added to the headers. If more than one propagation, which supports baggage, is present, the first baggage key-value pairs are being used.
The propagation functionality hereby replaces the zipkin middleware which was removed, since it implemented the propagation(only, without the cloud_controller adding trace data) for the B3Multi Header exclusively.
The current implementation with OTel can be configured to offer the exact same functionality/behaviour.
I have reviewed the contributing guide
I have viewed, signed, and submitted the Contributor License Agreement
I have made this pull request to the
main
branchI have run all the unit tests using
bundle exec rake
I have run CF Acceptance Tests