Updated readme.md to include link to stackdriver exporter package (#72)

Simon Zeltser · SergeyKanzhelev · commit f6a31ca1c1c0 · 2018-12-17T08:49:21.000-08:00
* 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&lt;-&gt;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 =&gt; Sample Properties =&gt; 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&lt;-&gt;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 =&gt; Sample Properties =&gt; 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
diff --git a/README.md b/README.md
@@ -3,10 +3,10 @@
 [![Gitter chat][gitter-image]][gitter-url]
 [![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)
 
-| Source | OpenCensus                                                       | Zipkin Exporter                                                                                  | Application Insights exporter                                                            |
-|--------|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
+| Source | OpenCensus                                                       | Zipkin Exporter                                                                                  | Application Insights exporter                                                            | Stackdriver                                                       |
+|--------|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|------------------------------------------------------------------|
 | 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] |
-
+ [![MyGet Nightly][opencensus-exporter-stackdriver-myget-image]][opencensus-exporter-stackdriver-myget-url]
 
 OpenCensus is a toolkit for collecting application performance and behavior
 data. It currently includes 3 APIs: stats, tracing and tags.
@@ -134,6 +134,8 @@ deprecate it for 18 months before removing it, if possible.
 [opencensus-exporter-zipkin-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus.Exporter.Zipkin
 [opencensus-exporter-ai-myget-image]:https://img.shields.io/myget/opencensus/vpre/OpenCensus.Exporter.ApplicationInsights.svg
 [opencensus-exporter-ai-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus.Exporter.ApplicationInsights
+[opencensus-exporter-stackdriver-myget-image]:https://img.shields.io/myget/opencensus/vpre/OpenCensus.Exporter.Stackdriver.svg
+[opencensus-exporter-stackdriver-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus.Exporter.Stackdriver
 [up-for-grabs-issues]: https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs
 [good-first-issues]: https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
 [zipkin-get-started]: https://zipkin.io/pages/quickstart.html
diff --git a/src/OpenCensus.Exporter.Stackdriver/Implementation/Constants.cs b/src/OpenCensus.Exporter.Stackdriver/Implementation/Constants.cs
@@ -30,7 +30,7 @@ internal class Constants
         public const string GLOBAL = "global";
 
         public const string PROJECT_ID_LABEL_KEY = "project_id";
-        public static readonly string OPENCENSUS_TASK_VALUE_DEFAULT = generateDefaultTaskValue();
+        public static readonly string OPENCENSUS_TASK_VALUE_DEFAULT = GenerateDefaultTaskValue();
 
         public const string GCP_GCE_INSTANCE_TYPE = "cloud.google.com/gce/instance";
         public const string GCP_INSTANCE_ID_KEY = "cloud.google.com/gce/instance_id";
@@ -43,10 +43,10 @@ internal class Constants
         public const string K8S_NAMESPACE_NAME_KEY = "k8s.io/namespace/name";
         public const string K8S_POD_NAME_KEY = "k8s.io/pod/name";
 
-        private static string generateDefaultTaskValue()
+        private static string GenerateDefaultTaskValue()
         {
             // Something like '<pid>@<hostname>'
             return $"dotnet-{System.Diagnostics.Process.GetCurrentProcess().Id}@{Environment.MachineName}";
         }
     }
-}
+}
diff --git a/src/OpenCensus.Exporter.Stackdriver/Implementation/GoogleCloudResourceUtils.cs b/src/OpenCensus.Exporter.Stackdriver/Implementation/GoogleCloudResourceUtils.cs
@@ -74,4 +74,4 @@ public static MonitoredResource GetDefaultResource(string projectId)
             return resource;
         }
     }
-}
+}
diff --git a/src/OpenCensus.Exporter.Stackdriver/Implementation/MetricsConversions.cs b/src/OpenCensus.Exporter.Stackdriver/Implementation/MetricsConversions.cs
@@ -334,4 +334,4 @@ internal static string GetStackdriverLabelKey(string label)
             return label.Replace('/', '_');
         }
     }
-}
+}
diff --git a/src/OpenCensus.Exporter.Stackdriver/Implementation/StackdriverStatsConfiguration.cs b/src/OpenCensus.Exporter.Stackdriver/Implementation/StackdriverStatsConfiguration.cs
@@ -68,4 +68,4 @@ public static StackdriverStatsConfiguration Default
             }
         }
     }
-}
+}
diff --git a/src/OpenCensus.Exporter.Stackdriver/Implementation/StackdriverTraceExporter.cs b/src/OpenCensus.Exporter.Stackdriver/Implementation/StackdriverTraceExporter.cs
@@ -86,12 +86,12 @@ public static Span.Types.Link ToLink(this ILink link)
             var ret = new Span.Types.Link();
             ret.SpanId = link.SpanId.ToLowerBase16();
             ret.TraceId = link.TraceId.ToLowerBase16();
-            
+
             if (link.Attributes != null)
             {
                 ret.Attributes = new Span.Types.Attributes
                 {
-                    
+
                     DroppedAttributesCount = OpenCensus.Trace.Config.TraceParams.Default.MaxNumberOfAttributes - link.Attributes.Count,
 
                     AttributeMap = { link.Attributes.ToDictionary(
@@ -144,7 +144,7 @@ internal class StackdriverTraceExporter : IHandler
         public StackdriverTraceExporter(string projectId)
         {
             googleCloudProjectId = new Google.Api.Gax.ResourceNames.ProjectName(projectId);
-            
+
         }
 
         public void Export(IList<ISpanData> spanDataList)
@@ -159,4 +159,4 @@ public void Export(IList<ISpanData> spanDataList)
             traceWriter.BatchWriteSpans(batchSpansRequest);
         }
     }
-}
+}
diff --git a/src/OpenCensus.Exporter.Stackdriver/StackdriverExporter.cs b/src/OpenCensus.Exporter.Stackdriver/StackdriverExporter.cs
@@ -116,4 +116,4 @@ public void Stop()
             }
         }
     }
-}
+}
diff --git a/src/Samples/TestZipkin.cs b/src/Samples/TestZipkin.cs
@@ -10,7 +10,6 @@ internal class TestZipkin
     {
         private static ITracer tracer = Tracing.Tracer;
 
-
         internal static object Run()
         {
             Console.WriteLine("Hello World!");
diff --git a/test/OpenCensus.Exporter.Stackdriver.Tests/Impl/StackdriverStatsConfigurationTests.cs b/test/OpenCensus.Exporter.Stackdriver.Tests/Impl/StackdriverStatsConfigurationTests.cs
@@ -65,4 +65,4 @@ public void StatsConfiguration_ByDefault_MonitoredResourceIsGlobal()
                 StackdriverStatsConfiguration.Default.MonitoredResource.Labels[Constants.PROJECT_ID_LABEL_KEY]);
         }
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ internal class Constants`
`30`	`30`	`public const string GLOBAL = "global";`
`31`	`31`
`32`	`32`	`public const string PROJECT_ID_LABEL_KEY = "project_id";`
`33`		`- public static readonly string OPENCENSUS_TASK_VALUE_DEFAULT = generateDefaultTaskValue();`
	`33`	`+ public static readonly string OPENCENSUS_TASK_VALUE_DEFAULT = GenerateDefaultTaskValue();`
`34`	`34`
`35`	`35`	`public const string GCP_GCE_INSTANCE_TYPE = "cloud.google.com/gce/instance";`
`36`	`36`	`public const string GCP_INSTANCE_ID_KEY = "cloud.google.com/gce/instance_id";`
`@@ -43,10 +43,10 @@ internal class Constants`
`43`	`43`	`public const string K8S_NAMESPACE_NAME_KEY = "k8s.io/namespace/name";`
`44`	`44`	`public const string K8S_POD_NAME_KEY = "k8s.io/pod/name";`
`45`	`45`
`46`		`- private static string generateDefaultTaskValue()`
	`46`	`+ private static string GenerateDefaultTaskValue()`
`47`	`47`	`{`
`48`	`48`	`// Something like '<pid>@<hostname>'`
`49`	`49`	`return $"dotnet-{System.Diagnostics.Process.GetCurrentProcess().Id}@{Environment.MachineName}";`
`50`	`50`	`}`
`51`	`51`	`}`
`52`		`-}`
	`52`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -74,4 +74,4 @@ public static MonitoredResource GetDefaultResource(string projectId)`
`74`	`74`	`return resource;`
`75`	`75`	`}`
`76`	`76`	`}`
`77`		`-}`
	`77`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -334,4 +334,4 @@ internal static string GetStackdriverLabelKey(string label)`
`334`	`334`	`return label.Replace('/', '_');`
`335`	`335`	`}`
`336`	`336`	`}`
`337`		`-}`
	`337`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -68,4 +68,4 @@ public static StackdriverStatsConfiguration Default`
`68`	`68`	`}`
`69`	`69`	`}`
`70`	`70`	`}`
`71`		`-}`
	`71`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -86,12 +86,12 @@ public static Span.Types.Link ToLink(this ILink link)`
`86`	`86`	`var ret = new Span.Types.Link();`
`87`	`87`	`ret.SpanId = link.SpanId.ToLowerBase16();`
`88`	`88`	`ret.TraceId = link.TraceId.ToLowerBase16();`
`89`		`-`
	`89`	`+`
`90`	`90`	`if (link.Attributes != null)`
`91`	`91`	`{`
`92`	`92`	`ret.Attributes = new Span.Types.Attributes`
`93`	`93`	`{`
`94`		`-`
	`94`	`+`
`95`	`95`	`DroppedAttributesCount = OpenCensus.Trace.Config.TraceParams.Default.MaxNumberOfAttributes - link.Attributes.Count,`
`96`	`96`
`97`	`97`	`AttributeMap = { link.Attributes.ToDictionary(`
`@@ -144,7 +144,7 @@ internal class StackdriverTraceExporter : IHandler`
`144`	`144`	`public StackdriverTraceExporter(string projectId)`
`145`	`145`	`{`
`146`	`146`	`googleCloudProjectId = new Google.Api.Gax.ResourceNames.ProjectName(projectId);`
`147`		`-`
	`147`	`+`
`148`	`148`	`}`
`149`	`149`
`150`	`150`	`public void Export(IList<ISpanData> spanDataList)`
`@@ -159,4 +159,4 @@ public void Export(IList<ISpanData> spanDataList)`
`159`	`159`	`traceWriter.BatchWriteSpans(batchSpansRequest);`
`160`	`160`	`}`
`161`	`161`	`}`
`162`		`-}`
	`162`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -116,4 +116,4 @@ public void Stop()`
`116`	`116`	`}`
`117`	`117`	`}`
`118`	`118`	`}`
`119`		`-}`
	`119`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@ internal class TestZipkin`
`10`	`10`	`{`
`11`	`11`	`private static ITracer tracer = Tracing.Tracer;`
`12`	`12`
`13`		`-`
`14`	`13`	`internal static object Run()`
`15`	`14`	`{`
`16`	`15`	`Console.WriteLine("Hello World!");`
Original file line number	Diff line number	Diff line change
`@@ -65,4 +65,4 @@ public void StatsConfiguration_ByDefault_MonitoredResourceIsGlobal()`
`65`	`65`	`StackdriverStatsConfiguration.Default.MonitoredResource.Labels[Constants.PROJECT_ID_LABEL_KEY]);`
`66`	`66`	`}`
`67`	`67`	`}`
`68`		`-}`
	`68`	`+}`