README.md in opentelemetry-instrumentation-mongo-0.16.0 vs README.md in opentelemetry-instrumentation-mongo-0.17.0
- old
+ new
@@ -28,14 +28,24 @@
OpenTelemetry::SDK.configure do |c|
c.use_all
end
```
-## Examples
+## Example
-Example usage of mongo can be seen in the `./example/mongo.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/mongo/example/mongo.rb)
+To run the example:
+1. Start MongoDB using docker-compose
+ * `docker-compose up mongo`
+2. In a separate terminal window, `cd` to the examples directory and install gems
+ * `cd example`
+ * `bundle install`
+3. Run the sample client script
+ * `ruby mongo.rb`
+
+This will run a few MongoDB commands, printing OpenTelemetry traces to the console as it goes.
+
## How can I get involved?
The `opentelemetry-instrumentation-mongo` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
@@ -49,5 +59,6 @@
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
[community-meetings]: https://github.com/open-telemetry/community#community-meetings
[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
+