diff options
Diffstat (limited to 'vendor/open-telemetry/gen-otlp-protobuf/README.md')
| -rw-r--r-- | vendor/open-telemetry/gen-otlp-protobuf/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/vendor/open-telemetry/gen-otlp-protobuf/README.md b/vendor/open-telemetry/gen-otlp-protobuf/README.md new file mode 100644 index 000000000..f1ea7a63a --- /dev/null +++ b/vendor/open-telemetry/gen-otlp-protobuf/README.md @@ -0,0 +1,31 @@ +[](https://github.com/opentelemetry-php/gen-otlp-protobuf/releases) +[](https://github.com/open-telemetry/opentelemetry-php/tree/main/proto/otel) +[](https://github.com/opentelemetry-php/gen-otlp-protobuf) +[](https://packagist.org/packages/open-telemetry/gen-otlp-protobuf/) +[](https://packagist.org/packages/open-telemetry/gen-otlp-protobuf/) + +# OpenTelemetry protobuf files + +## Protobuf Runtime library + +OTLP exporting requires a [protobuf runtime library](https://github.com/protocolbuffers/protobuf/tree/main/php). + +There exist two protobuf runtime libraries that offer the same set of APIs, allowing developers to choose the one that +best suits their needs. + +This package requires `google/protobuf`, which is the native implementation. It is easy to install and a good way to get +started quickly. + +Alternatively, and the recommended option for production is to install the Protobuf C extension for PHP. The extension +makes OTLP exporting _significantly_ more performant. The extension can be installed with the following command: + +```shell +pecl install protobuf +``` + +The extension can be installed alongside the native library, and it will be used instead if available. + +## Contributing + +This repository is a read-only git subtree split. +To contribute, please see the main [OpenTelemetry PHP monorepo](https://github.com/open-telemetry/opentelemetry-php). |