Skip to content

Commit e1b8a86

Browse files
authored
Update README.md
1 parent d0ad8a2 commit e1b8a86

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

packages/opentelemetry/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Appium Opentelemetry Plugin
2+
3+
With Appium 2.0, we can now use opentelemetry as observability tool without bundling it with appium main server
4+
5+
This plugin will help generate http traces automatically once used and also allow dynamic configurations for different exporters such as prometheus, jaeger, zipkin or just basic console logs.
6+
7+
## Installation - Server
8+
9+
Install the plugin using Appium's plugin CLI, either as a named plugin or via NPM (TODO):
10+
11+
```
12+
appium plugin install opentelemetry
13+
appium plugin install --source=npm @browserstack/opentelemetry-plugin
14+
```
15+
16+
Install the plugin using Appium's plugin CLI, locally:
17+
18+
```
19+
appium plugin install <path-to-repo>/packages/opentelemetry --source local
20+
```
21+
22+
## Activation
23+
24+
The plugin will not be active unless turned on when invoking the Appium server:
25+
26+
```
27+
appium --plugins=opentelemetry
28+
```

0 commit comments

Comments
 (0)