Skip to content

Commit a1e40d9

Browse files
committed
add doc for transport protocol
1 parent a6dbb07 commit a1e40d9

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ import 'package:opentelemetry/sdk.dart' as otel_sdk;
2929
final exporter = otel_sdk.CollectorExporter(Uri.parse('https://my-collector.com/v1/traces'));
3030
```
3131

32+
The CollectorExporter supports transport protocols including `http/protobuf` and `grpc`. The default protocol is `http/protobuf`.
33+
3234
#### ConsoleExporter
3335

3436
The ConsoleExporter has no requirements, and has no configuration options.
@@ -190,6 +192,7 @@ const result = doWork();
190192
```
191193

192194
You can also create Span Events with additional Attributes:
195+
193196
```dart
194197
span.addEvent('some log', attributes: {
195198
'log.severity': 'error',
@@ -203,6 +206,7 @@ span.addEvent('some log', attributes: {
203206
In order to generate protobuf definitions, you must have [protoc](https://github.com/protocolbuffers/protobuf/releases) installed and available in your path.
204207

205208
### Publishing New Versions
206-
See https://github.com/Workiva/Observability/blob/master/doc/publishing_opentelemetry_dart.md
209+
210+
See <https://github.com/Workiva/Observability/blob/master/doc/publishing_opentelemetry_dart.md>
207211

208212
Only Workiva maintainers can publish new versions of opentelemetry-dart.

0 commit comments

Comments
 (0)