|
| 1 | +# TurboMqtt Telemetry |
| 2 | + |
| 3 | +TurboMqtt supports [OpenTelemetry](https://opentelemetry.io/) - this page explains how to enable it. |
| 4 | + |
| 5 | +## Subscribing to TurboMqtt `Meter` and `ActivitySource` |
| 6 | + |
| 7 | +We provide some helpful extension methods to be used alongside the `OpenTelemetryBuilder` type: |
| 8 | + |
| 9 | +* `AddTurboMqttMetrics()` - subscribes to all TurboMqtt metric sources. |
| 10 | +* `AddTurboMqttTracing()` - subscribes to all TurboMqtt trace sources, which we currently do not support. |
| 11 | + |
| 12 | +An end to end example of how to use these settings: |
| 13 | + |
| 14 | +```csharp |
| 15 | +var builder = new HostBuilder(); |
| 16 | + |
| 17 | +builder |
| 18 | + .ConfigureAppConfiguration(configBuilder => |
| 19 | + { |
| 20 | + configBuilder |
| 21 | + .AddJsonFile("appsettings.json", optional: false); |
| 22 | + }) |
| 23 | + .ConfigureLogging(logging => |
| 24 | + { |
| 25 | + logging.ClearProviders(); |
| 26 | + logging.AddConsole(); |
| 27 | + }) |
| 28 | + .ConfigureServices(s => |
| 29 | + { |
| 30 | + // parse MqttConfig from appsettings.json |
| 31 | + var optionsBuilder = s.AddOptions<MqttConfig>(); |
| 32 | + optionsBuilder.BindConfiguration("MqttConfig"); |
| 33 | + s.AddTurboMqttClientFactory(); |
| 34 | + |
| 35 | + var resourceBuilder = ResourceBuilder.CreateDefault().AddService("DevNullConsumer", |
| 36 | + "TurboMqtt.Examples", |
| 37 | + serviceInstanceId: Dns.GetHostName()); |
| 38 | + |
| 39 | + s.AddOpenTelemetry() |
| 40 | + .WithMetrics(m => |
| 41 | + { |
| 42 | + m |
| 43 | + .SetResourceBuilder(resourceBuilder) |
| 44 | + .AddTurboMqttMetrics() |
| 45 | + .AddOtlpExporter(options => |
| 46 | + { |
| 47 | + options.Endpoint = new Uri("http://localhost:4317"); // Replace with the appropriate endpoint |
| 48 | + options.Protocol = OpenTelemetry.Exporter.OtlpExportProtocol.Grpc; // or HttpProtobuf |
| 49 | + }); |
| 50 | + }) |
| 51 | + .WithTracing(t => |
| 52 | + { |
| 53 | + t |
| 54 | + .SetResourceBuilder(resourceBuilder) |
| 55 | + .AddTurboMqttTracing() |
| 56 | + .AddOtlpExporter(options => |
| 57 | + { |
| 58 | + options.Endpoint = new Uri("http://localhost:4317"); // Replace with the appropriate endpoint |
| 59 | + options.Protocol = OpenTelemetry.Exporter.OtlpExportProtocol.Grpc; // or HttpProtobuf |
| 60 | + }); |
| 61 | + }); |
| 62 | + s.AddHostedService<MqttConsumerService>(); |
| 63 | + }); |
| 64 | + |
| 65 | +var host = builder.Build(); |
| 66 | + |
| 67 | +await host.RunAsync(); |
| 68 | +``` |
| 69 | + |
| 70 | +## Collected Metrics |
| 71 | + |
| 72 | +What metrics does TurboMqtt expose? |
| 73 | + |
| 74 | +* `recv_messages` - by `clientId`, `PacketType`, `MqttProtocolVersion` |
| 75 | +* `recv_bytes` - by `clientId`, `MqttProtocolVersion` |
| 76 | +* `sent_messages` - by `clientId`, `PacketType`, `MqttProtocolVersion` |
| 77 | +* `sent_bytes` - by `clientId`, `MqttProtocolVersion` |
| 78 | + |
| 79 | +## Disabling TurboMqtt OpenTelemetry for Performance Reasons |
| 80 | + |
| 81 | +If you want to disable the low-level emission of OpenTelemetry metrics and traces, we support that on the `MqttClientConnectOptions` class you have to use when creating an `IMqttClient`: |
| 82 | + |
| 83 | +```csharp |
| 84 | +var tcpClientOptions = new MqttClientTcpOptions(config.Host, config.Port); |
| 85 | +var clientConnectOptions = new MqttClientConnectOptions(config.ClientId, MqttProtocolVersion.V3_1_1) |
| 86 | +{ |
| 87 | + UserName = config.User, |
| 88 | + Password = config.Password, |
| 89 | + KeepAliveSeconds = 5, |
| 90 | + EnableOpenTelemetry = false // disable telemetry |
| 91 | +}; |
| 92 | + |
| 93 | +var client = await _clientFactory.CreateTcpClient(clientConnectOptions, tcpClientOptions); |
| 94 | +``` |
0 commit comments