Skip to content

Commit

Permalink
Merge pull request #2 from objectiser/readme
Browse files Browse the repository at this point in the history
Updated readme and publisher
  • Loading branch information
objectiser authored Nov 27, 2019
2 parents cb9fe75 + 14312c0 commit 9fb6c3d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ npm-debug.log
node_modules/
out/
.vs/
.vscode/
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
# VSCode extension for Jaeger

Jaeger, inspired by [Dapper](https://research.google.com/pubs/pub36356.html) and [OpenZipkin](http://zipkin.io/), is a distributed tracing system released as open source by Uber Technologies. It is used for monitoring and troubleshooting microservices-based distributed systems, including:

* Distributed context propagation
* Distributed transaction monitoring
* Root cause analysis
* Service dependency analysis
* Performance / latency optimization

Once a Jaeger tracing system has been started, any applications (services) that are being tested within the IDE can report their tracing infomration to Jaeger through the use of an [OpenTracing compliant tracer](https://www.jaegertracing.io/docs/latest/client-libraries/) or using the emerging [OpenTelemetry clients](https://opentelemetry.io/) with Jaeger exporter.

This extension contributes three commands that can be used to manage a Jaeger _all-in-one_ server from within the IDE. These commands are:

* Observability: Start Jaeger [jaeger.start]

This command will start the Jaeger _all-in-one_ server (using in-memory storage).

* Observability: Show Jaeger UI [jaeger.ui]

This command will open a browser to show the Jaeger UI. If the _auchenberg.vscode-browser-preview_ Browser Preview extension (by Kenneth Auchenberg) is installed, the UI will be displayed using the internal browser. Otherwise it will be displayed in the default browser.

* Observability: Stop Jaeger [jaeger.stop]

This command will terminate the Jaeger _all-in-one_ server.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "jaeger",
"description": "Jaeger - Distributed Tracing",
"version": "0.1.0",
"publisher": "vscode-jaeger",
"publisher": "jaegertracing",
"engines": {
"vscode": "^1.38.0"
},
Expand Down

0 comments on commit 9fb6c3d

Please sign in to comment.