Skip to content

Commit 5b4808f

Browse files
authored
add excon readme (#262)
1 parent aa351fc commit 5b4808f

File tree

2 files changed

+51
-1
lines changed

2 files changed

+51
-1
lines changed

adapters/excon/README.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Excon Adapter
2+
3+
The excon adapter is a community-maintained instrumentation adapter for the [excon][excon-home] HTTP library.
4+
5+
## How do I get started?
6+
7+
Install the gem using:
8+
9+
```
10+
gem install opentelemetry-adapters-excon
11+
```
12+
13+
Or, if you use [bundler][bundler-home], include `opentelemetry-adapters-excon` to your `Gemfile`.
14+
15+
## Usage
16+
17+
To install the instrumentation adapter, call `use` with the name of the instrumentation.
18+
19+
20+
```ruby
21+
OpenTelemetry::SDK.configure do |c|
22+
c.use 'OpenTelemetry::Adapters::Excon'
23+
end
24+
```
25+
26+
Alternatively, you can also call `use_all` to install all the available adapters.
27+
28+
```ruby
29+
OpenTelemetry::SDK.configure do |c|
30+
c.use_all
31+
end
32+
```
33+
34+
## How can I get involved?
35+
36+
The `opentelemetry-adapters-excon` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
37+
38+
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] 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].
39+
40+
## License
41+
42+
The `opentelemetry-adapters-all` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
43+
44+
[excon-home]: https://github.com/excon/excon
45+
[bundler-home]: https://bundler.io
46+
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
47+
[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
48+
[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
49+
[community-meetings]: https://github.com/open-telemetry/community#community-meetings
50+
[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby

adapters/excon/opentelemetry-adapters-excon.gemspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
2121

2222
spec.files = ::Dir.glob('lib/**/*.rb') +
2323
::Dir.glob('*.md') +
24-
['LICENSE']
24+
['README.md', 'LICENSE']
2525
spec.require_paths = ['lib']
2626
spec.required_ruby_version = '>= 2.5.0'
2727

0 commit comments

Comments
 (0)