End-to-end example applications #936
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| **/.classpath | ||
| **/.dockerignore | ||
| **/.env | ||
| **/.git | ||
| **/.gitignore | ||
| **/.project | ||
| **/.settings | ||
| **/.toolstarget | ||
| **/.vs | ||
| **/.vscode | ||
| **/*.*proj.user | ||
| **/*.dbmdl | ||
| **/*.jfm | ||
| **/docker-compose* | ||
| **/Dockerfile* | ||
| **/bin | ||
| **/obj | ||
| **/*.yaml | ||
| **/*.yml | ||
| **/*.md | ||
| **/*.ps1 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # OpenTelemetry Example Application | ||
|
|
||
| This set of projects is an example distributed application comprised of two | ||
| components: | ||
|
|
||
| 1. An ASP.NET Core Web API | ||
| 2. A background Worker Service | ||
|
|
||
| The application demonstrates a number of OpenTelemetry concepts: | ||
|
|
||
| * OpenTelemetry APIs for distributed context propagation. | ||
| * Basic conventions of how messaging systems are handled in OpenTelemetry. | ||
|
|
||
| The Web API publishes messages to RabbitMQ which the Worker Service consumes. | ||
| Distributed context propagation is achieved using OpenTelemetry APIs to inject | ||
| and extract trace context in the headers of the published messages. | ||
|
|
||
| The Zipkin exporter is configured for viewing the distributed traces. | ||
|
|
||
| ## Running the example | ||
|
|
||
| A running instance of RabbitMQ and Zipkin are required. These can easily be | ||
| spun up in docker containers. | ||
|
|
||
| The `WebApi` and `WorkerService` projects can be run from this directory as | ||
| follows: | ||
|
|
||
| ```shell | ||
| dotnet run --project WebApi | ||
| dotnet run --project WorkerService | ||
| ``` | ||
|
|
||
| Instead of running the projects individually, if you are using Docker Desktop, | ||
| a `docker-compose` file is provided. This makes standing up the Zipkin and | ||
| RabbitMQ dependencies easy, as well as starting both applications. | ||
|
|
||
| To run the example using `docker-compose`, run the following from this | ||
| directory: | ||
|
|
||
| ```shell | ||
| docker-compose up --build | ||
| ``` | ||
|
|
||
| With everything running: | ||
|
|
||
| * [Invoke the Web API](http://localhost:5000/SendMessage) to send a message. | ||
| * If you have run RabbitMQ and Zipkin with default settings: | ||
| * View your traces with Zipkin [here](http://localhost:9411/zipkin) | ||
| * Manage RabbitMQ [here](http://localhost:15672/) | ||
| * user = guest | ||
| * password = guest | ||
|
|
||
| ## References | ||
|
|
||
| * [Docker Desktop](https://www.docker.com/products/docker-desktop) | ||
| * [OpenTelemetry Project](https://opentelemetry.io/) | ||
| * [RabbitMQ](https://www.rabbitmq.com/) | ||
| * [Worker Service](https://docs.microsoft.com/en-us/azure/azure-monitor/app/worker-service) | ||
| * [Zipkin](https://zipkin.io) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| // <copyright file="MessageReceiver.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics; | ||
| using System.Linq; | ||
| using System.Text; | ||
| using System.Threading; | ||
| using Microsoft.Extensions.Logging; | ||
| using OpenTelemetry.Context.Propagation; | ||
| using RabbitMQ.Client; | ||
| using RabbitMQ.Client.Events; | ||
|
|
||
| namespace Utils.Messaging | ||
| { | ||
| public class MessageReceiver : IDisposable | ||
| { | ||
| private static readonly ActivitySource ActivitySource = new ActivitySource(nameof(MessageReceiver)); | ||
| private static readonly ITextFormat TextFormat = new TraceContextFormat(); | ||
|
|
||
| private readonly ILogger<MessageReceiver> logger; | ||
| private readonly IConnection connection; | ||
| private readonly IModel channel; | ||
|
|
||
| public MessageReceiver(ILogger<MessageReceiver> logger) | ||
| { | ||
| this.logger = logger; | ||
| this.connection = RabbitMqHelper.CreateConnection(); | ||
| this.channel = RabbitMqHelper.CreateModelAndDeclareTestQueue(this.connection); | ||
| } | ||
|
|
||
| public void Dispose() | ||
| { | ||
| this.channel.Dispose(); | ||
| this.connection.Dispose(); | ||
| } | ||
|
|
||
| public void StartConsumer() | ||
| { | ||
| RabbitMqHelper.StartConsumer(this.channel, this.ReceiveMessage); | ||
| } | ||
|
|
||
| public void ReceiveMessage(BasicDeliverEventArgs ea) | ||
| { | ||
| // Extract the ActivityContext of the upstream parent from the message headers. | ||
| var parentContext = TextFormat.Extract(ea.BasicProperties, this.ExtractTraceContextFromBasicProperties); | ||
|
|
||
| // Start an activity with a name following the semantic convention of the OpenTelemetry messaging specification. | ||
| // https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/messaging.md#span-name | ||
| var activityName = $"{ea.RoutingKey} receive"; | ||
|
|
||
| using (var activity = ActivitySource.StartActivity(activityName, ActivityKind.Consumer, parentContext)) | ||
| { | ||
| try | ||
| { | ||
| var message = Encoding.UTF8.GetString(ea.Body.Span.ToArray()); | ||
|
|
||
| this.logger.LogInformation($"Message received: [{message}]"); | ||
|
|
||
| activity.AddTag("message", message); | ||
alanwest marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // The OpenTelemetry messaging specification defines a number of attributes. These attributes are added here. | ||
| RabbitMqHelper.AddMessagingTags(activity); | ||
|
|
||
|
|
||
| // Simulate some work | ||
| Thread.Sleep(1000); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| this.logger.LogError(ex, "Message processing failed."); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private IEnumerable<string> ExtractTraceContextFromBasicProperties(IBasicProperties props, string key) | ||
| { | ||
| try | ||
| { | ||
| if (props.Headers.TryGetValue(key, out var value)) | ||
| { | ||
| var bytes = value as byte[]; | ||
| return new[] { Encoding.UTF8.GetString(bytes) }; | ||
| } | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| this.logger.LogError(ex, "Failed to extract trace context: {ex}"); | ||
| } | ||
|
|
||
| return Enumerable.Empty<string>(); | ||
| } | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| // <copyright file="MessageSender.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics; | ||
| using System.Text; | ||
| using Microsoft.Extensions.Logging; | ||
| using OpenTelemetry.Context.Propagation; | ||
| using RabbitMQ.Client; | ||
|
|
||
| namespace Utils.Messaging | ||
| { | ||
| public class MessageSender : IDisposable | ||
| { | ||
| private static readonly ActivitySource ActivitySource = new ActivitySource(nameof(MessageSender)); | ||
| private static readonly ITextFormat TextFormat = new TraceContextFormat(); | ||
|
|
||
| private readonly ILogger<MessageSender> logger; | ||
| private readonly IConnection connection; | ||
| private readonly IModel channel; | ||
|
|
||
| public MessageSender(ILogger<MessageSender> logger) | ||
| { | ||
| this.logger = logger; | ||
| this.connection = RabbitMqHelper.CreateConnection(); | ||
| this.channel = RabbitMqHelper.CreateModelAndDeclareTestQueue(this.connection); | ||
| } | ||
|
|
||
| public void Dispose() | ||
| { | ||
| this.channel.Dispose(); | ||
| this.connection.Dispose(); | ||
| } | ||
|
|
||
| public string SendMessage() | ||
| { | ||
| try | ||
| { | ||
| // Start an activity with a name following the semantic convention of the OpenTelemetry messaging specification. | ||
| // https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/messaging.md#span-name | ||
| var activityName = $"{RabbitMqHelper.TestQueueName} send"; | ||
|
|
||
| using (var activity = ActivitySource.StartActivity(activityName, ActivityKind.Producer)) | ||
| { | ||
| var props = this.channel.CreateBasicProperties(); | ||
|
|
||
| // Inject the ActivityContext into the message headers to propagate trace context to the receiving service. | ||
| TextFormat.Inject(activity.Context, props, this.InjectTraceContextIntoBasicProperties); | ||
alanwest marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // The OpenTelemetry messaging specification defines a number of attributes. These attributes are added here. | ||
| RabbitMqHelper.AddMessagingTags(activity); | ||
alanwest marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| var body = $"Published message: DateTime.Now = {DateTime.Now}."; | ||
|
|
||
| this.channel.BasicPublish( | ||
| exchange: RabbitMqHelper.DefaultExchangeName, | ||
| routingKey: RabbitMqHelper.TestQueueName, | ||
| basicProperties: props, | ||
| body: Encoding.UTF8.GetBytes(body)); | ||
|
|
||
| this.logger.LogInformation($"Message sent: [{body}]"); | ||
|
|
||
| return body; | ||
| } | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| this.logger.LogError(ex, "Message publishing failed."); | ||
| throw; | ||
| } | ||
| } | ||
|
|
||
| private void InjectTraceContextIntoBasicProperties(IBasicProperties props, string key, string value) | ||
| { | ||
| try | ||
| { | ||
| if (props.Headers == null) | ||
| { | ||
| props.Headers = new Dictionary<string, object>(); | ||
| } | ||
|
|
||
| props.Headers[key] = value; | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| this.logger.LogError(ex, "Failed to inject trace context."); | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like some conflict resolve header?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh nice catch! Apparently, Visual Studio was like
this is fine.