Skip to content
This repository was archived by the owner on Dec 18, 2023. It is now read-only.

Commit fa7d468

Browse files
Simon ZeltserSergeyKanzhelev
authored andcommitted
Split the packages table in README.md (#74)
* Introducing Stackdriver Exporter for Opencensus C# library - Current implementation can only store string values - Added the exporter and trace handler only - The exporter relies on newest Trace API from Stackdriver. * Updating translation from ISpan to Stackdriver's Span to cover more fields * Fixing the issue that prevented Stackdriver API call to succeed: now construction of Span resource is taken care of by SpanName class that is part of Stackdriver Trace V2 API. * - Added support for capturing all types of trace spans (long/bool/string) - Fixed csproj, so it produces both .NET Core and .NET versions. It also means signing the assembly using the same mechanism as other assemblies in the solution * - Added support for storing links - Minor fixes to proto<->opencensus translation methods * Fixing merge issue * Added command line support for the Samples project. This will make it easier to script testing multiple exporters as well as prevent commenting and uncommenting different test procedures for different exporters. Finally, it will making test code cleaner for showing samples embedded in documentation website. In order to test the exporter, you can either execute it from the command line: samples.dll prometheus or to debug using Visual Studio: Debug => Sample Properties => Debug. Now create a profile for your testing execution and fill application arguments if needed. Now choose your profile in running configuration of Visual Studio. Running settings are local to the machine and are ignored in PRs. * Adding sceleton of metrics support in Stackdriver Exporter. Currently we can't detect all types of monitoring resources but we can ship the batches of metrics with time series to Stackdriver. Thorough testing TBD * Fixing a few bugs in Stackdriver metrics exporter - Small refactoring - Assinging default values for time intervals * - Fixing a few bugs around metric creation and labels - Refactoring MetricsConversions - Fixing stackdriver stats configuration - population of default resource and projects * First working version of Stackdriver Stats Exporter. 1) Fixed bugs related to Stackdriver Metrics Descriptor creation 2) Renamed Metrics Exporter to Stats Exporter to follow Opencensus terminology 3) Cache Stackdriver Metrics Descriptors locally so it's easy which descriptor holds the time series to upload 4) Fixed test code that was producing the metrics using Opencensus and uploading it to Stackdriver 5) Minor refactoring Current limitations: 1) Supporting only string labels 2) We support only "Global" monitored resource. We need to detect dynamically where the code is running and attach corresponding labels to the monitored resource, so metrics are stored correctly 3) More Tests * Removing commented lines * Fixed Stackdriver export interval propagation Added Opencensus headers into every call into Stackdriver APIs Added consts for resources that Stackdriver Exporter should auto-detect when running on GCP * - Added test project for Stackdriver Exporter - Added tests for StackdriverStatsConfiguration * Trying to fix the tests that fail on CI as a result of wrong signing key for InternalVisibleTo * Updating Travis build definition to latest .netcore sdk and running all tests * Adding an option to set google cloud projectId in environment variable for testing purposes(Stackdriver exporter). * Temporarily commenting out lines that read from a friend assembly as it doesn't work on a build server * Added AssemblyInfo.cs into Stackdriver Exporter, so it's visible to tests on both signed and unsigned builds * Introducing Stackdriver Exporter for Opencensus C# library - Current implementation can only store string values - Added the exporter and trace handler only - The exporter relies on newest Trace API from Stackdriver. * Updating translation from ISpan to Stackdriver's Span to cover more fields * Fixing the issue that prevented Stackdriver API call to succeed: now construction of Span resource is taken care of by SpanName class that is part of Stackdriver Trace V2 API. * - Added support for storing links - Minor fixes to proto<->opencensus translation methods * Added command line support for the Samples project. This will make it easier to script testing multiple exporters as well as prevent commenting and uncommenting different test procedures for different exporters. Finally, it will making test code cleaner for showing samples embedded in documentation website. In order to test the exporter, you can either execute it from the command line: samples.dll prometheus or to debug using Visual Studio: Debug => Sample Properties => Debug. Now create a profile for your testing execution and fill application arguments if needed. Now choose your profile in running configuration of Visual Studio. Running settings are local to the machine and are ignored in PRs. * Adding sceleton of metrics support in Stackdriver Exporter. Currently we can't detect all types of monitoring resources but we can ship the batches of metrics with time series to Stackdriver. Thorough testing TBD * Fixing a few bugs in Stackdriver metrics exporter - Small refactoring - Assinging default values for time intervals * - Fixing a few bugs around metric creation and labels - Refactoring MetricsConversions - Fixing stackdriver stats configuration - population of default resource and projects * First working version of Stackdriver Stats Exporter. 1) Fixed bugs related to Stackdriver Metrics Descriptor creation 2) Renamed Metrics Exporter to Stats Exporter to follow Opencensus terminology 3) Cache Stackdriver Metrics Descriptors locally so it's easy which descriptor holds the time series to upload 4) Fixed test code that was producing the metrics using Opencensus and uploading it to Stackdriver 5) Minor refactoring Current limitations: 1) Supporting only string labels 2) We support only "Global" monitored resource. We need to detect dynamically where the code is running and attach corresponding labels to the monitored resource, so metrics are stored correctly 3) More Tests * Removing commented lines * Fixed Stackdriver export interval propagation Added Opencensus headers into every call into Stackdriver APIs Added consts for resources that Stackdriver Exporter should auto-detect when running on GCP * - Added test project for Stackdriver Exporter - Added tests for StackdriverStatsConfiguration * Trying to fix the tests that fail on CI as a result of wrong signing key for InternalVisibleTo * Adding an option to set google cloud projectId in environment variable for testing purposes(Stackdriver exporter). * Temporarily commenting out lines that read from a friend assembly as it doesn't work on a build server * Added AssemblyInfo.cs into Stackdriver Exporter, so it's visible to tests on both signed and unsigned builds * Rebasing origin to upstream * Updated readme to include a link to Stackdriver package * Update Stackdriver Exporter instructions and split the table of nuget packages for better visibility on various screen sizes * Add user-agent header in Stackdriver metrics and trace exporters * Revert "Add user-agent header in Stackdriver metrics and trace exporters" This reverts commit 4fbc6d7.
1 parent 6c40569 commit fa7d468

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,17 @@
33
[![Gitter chat][gitter-image]][gitter-url]
44
[![Build Status](https://opencensus.visualstudio.com/continuous-integration/_apis/build/status/ci-myget-update.yml)](https://opencensus.visualstudio.com/continuous-integration/_build/latest?definitionId=3)
55

6-
| Source | OpenCensus | Zipkin Exporter | Application Insights exporter | Stackdriver |
7-
|--------|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|------------------------------------------------------------------|
8-
| MyGet | [![MyGet Nightly][opencensus-myget-image]][opencensus-myget-url] | [![MyGet Nightly][opencensus-exporter-zipkin-myget-image]][opencensus-exporter-zipkin-myget-url] | [![MyGet Nightly][opencensus-exporter-ai-myget-image]][opencensus-exporter-ai-myget-url] |
9-
[![MyGet Nightly][opencensus-exporter-stackdriver-myget-image]][opencensus-exporter-stackdriver-myget-url]
6+
| Source | OpenCensus Core Package |
7+
| --- | -- |
8+
| MyGet | [![MyGet Nightly][opencensus-myget-image]][opencensus-myget-url] |
9+
10+
## Exporters Packages
11+
12+
| Exporter | MyGet |
13+
| --- | --- |
14+
| Zipkin | [![MyGet Nightly][opencensus-exporter-zipkin-myget-image]][opencensus-exporter-zipkin-myget-url] |
15+
| Application Insights | [![MyGet Nightly][opencensus-exporter-ai-myget-image]][opencensus-exporter-ai-myget-url]
16+
| Stackdriver | [![MyGet Nightly][opencensus-exporter-stackdriver-myget-image]][opencensus-exporter-stackdriver-myget-url]
1017

1118
OpenCensus is a toolkit for collecting application performance and behavior
1219
data. It currently includes 3 APIs: stats, tracing and tags.
@@ -81,13 +88,18 @@ finally
8188

8289
### Using Stackdriver Exporter
8390

84-
1. Enable [Stackdriver Trace][stackdriver-setup] resource.
85-
2. Instantiate a new instance of `StackdriverExporter` with your Google Cloud's ProjectId
86-
3. See [sample][stackdriver-sample] for example use.
91+
1. Add [Stackdriver Exporter package][opencensus-exporter-stackdriver-myget-url] reference.
92+
2. Enable [Stackdriver Trace][stackdriver-trace-setup] API.
93+
3. Enable [Stackdriver Monitoring][stackdriver-monitoring-setup] API.
94+
4. Instantiate a new instance of `StackdriverExporter` with your Google Cloud's ProjectId
95+
5. See [sample][stackdriver-sample] for example use.
8796

8897
``` csharp
89-
var exporter = new StackdriverExporter("YOUR-GOOGLE-PROJECT-ID", Tracing.ExportComponent);
90-
exporter.Start();
98+
var exporter = new StackdriverExporter(
99+
"YOUR-GOOGLE-PROJECT-ID",
100+
Tracing.ExportComponent,
101+
Stats.ViewManager);
102+
exporter.Start();
91103
```
92104

93105
### Using Application Insights exporter
@@ -140,7 +152,8 @@ deprecate it for 18 months before removing it, if possible.
140152
[good-first-issues]: https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
141153
[zipkin-get-started]: https://zipkin.io/pages/quickstart.html
142154
[ai-get-started]: https://docs.microsoft.com/azure/application-insights
143-
[stackdriver-setup]: https://cloud.google.com/trace/docs/setup/
155+
[stackdriver-trace-setup]: https://cloud.google.com/trace/docs/setup/
156+
[stackdriver-monitoring-setup]: https://cloud.google.com/monitoring/api/enable-api
144157
[semver]: http://semver.org/
145158
[ai-sample]: https://github.com/census-instrumentation/opencensus-csharp/blob/develop/src/Samples/TestApplicationInsights.cs
146159
[stackdriver-sample]: https://github.com/census-instrumentation/opencensus-csharp/blob/develop/src/Samples/TestStackdriver.cs

0 commit comments

Comments
 (0)