From 14312c0cb150dc900cb43b3fbe64c64c205c1c0a Mon Sep 17 00:00:00 2001 From: Gary Brown Date: Wed, 27 Nov 2019 10:56:46 +0000 Subject: [PATCH] Updated readme and publisher --- .gitignore | 1 + README.md | 23 +++++++++++++++++++++++ package.json | 2 +- 3 files changed, 25 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 2efb34f..daddb9a 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ npm-debug.log node_modules/ out/ .vs/ +.vscode/ diff --git a/README.md b/README.md index eab7bb6..bbfbbfe 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/package.json b/package.json index 3b5798a..e3a6997 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "jaeger", "description": "Jaeger - Distributed Tracing", "version": "0.1.0", - "publisher": "vscode-jaeger", + "publisher": "jaegertracing", "engines": { "vscode": "^1.38.0" },