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

Commit ebfd660

Browse files
SergeyKanzhelevSergeyKanzhelev
authored
Catch up docs updates after release (#79)
* readme and changelog updates * fix issues
1 parent da68b4b commit ebfd660

File tree

2 files changed

+132
-14
lines changed

2 files changed

+132
-14
lines changed

‎CHANGELOG.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
1-
# Unreleased
1+
# Changelog
22

3+
Please update changelog as part of any significant pull request. Place short
4+
description of your change into "Unreleased" section. As part of release
5+
process content of "Unreleased" section content will generate release notes for
6+
the release.
7+
8+
## Unreleased
9+
10+
## 0.1.0-alpha-33381
11+
12+
Released [12/18/2018](https://github.com/census-instrumentation/opencensus-csharp/releases/tag/0.1.0-alpha-33381).
13+
14+
- Collectors for ASP.NET Core and .NET Core HttpClient.
15+
- Initial version of Ocagent exporter implemented.
16+
- Initial version of StackDriver exporter implemented.
317
- Support double attributes according to the [spec change](https://github.com/census-instrumentation/opencensus-specs/issues/172).
418
- Initial implementation of Prometheus exporter.
519
- Initial version of Application Insights exporter implemented.

‎README.md‎

Lines changed: 117 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,6 @@
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 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]
17-
186
OpenCensus is a toolkit for collecting application performance and behavior
197
data. It currently includes 3 APIs: stats, tracing and tags.
208

@@ -29,7 +17,99 @@ We encourage contributions. Use tags [up-for-grabs][up-for-grabs-issues] and
2917
[good first issue][good-first-issues] to get started with the project. Follow
3018
[CONTRIBUTING](CONTRIBUTING.md) guide to report issues or submit a proposal.
3119

32-
## OpenCensus Quickstart
20+
## Packages
21+
22+
### API and implementation
23+
24+
| Package | MyGet (CI) | NuGet (releases) |
25+
| ----------------------- | ---------------- | -----------------|
26+
| OpenCensus | [![MyGet Nightly][opencensus-myget-image]][opencensus-myget-url] | [![NuGet Release][opencensus-nuget-image]][opencensus-nuget-url] |
27+
| OpenCensus.Abstractions | [![MyGet Nightly][opencensus-abs-myget-image]][opencensus-abs-myget-url] | [![NuGet Release][opencensus-abs-nuget-image]][opencensus-abs-nuget-url] |
28+
29+
### Data Collectors
30+
31+
| Package | MyGet (CI) | NuGet (releases) |
32+
| ----------------------- | ---------------- | -----------------|
33+
| Asp.Net Core | [![MyGet Nightly][opencensus-collect-aspnetcore-myget-image]][opencensus-collect-aspnetcore-myget-url] | [![NuGet Release][opencensus-collect-aspnetcore-nuget-image]][opencensus-collect-aspnetcore-nuget-url] |
34+
| .Net Core HttpClient | [![MyGet Nightly][opencensus-collect-deps-myget-image]][opencensus-collect-deps-myget-url] | [![NuGet Release][opencensus-collect-deps-nuget-image]][opencensus-collect-deps-nuget-url] |
35+
36+
### Exporters Packages
37+
38+
| Package | MyGet (CI) | NuGet (releases) |
39+
| ----------------------- | ---------------- | -----------------|
40+
| Zipkin | [![MyGet Nightly][opencensus-exporter-zipkin-myget-image]][opencensus-exporter-zipkin-myget-url] | [![NuGet release][opencensus-exporter-zipkin-nuget-image]][opencensus-exporter-zipkin-nuget-url] |
41+
| Prometheus | [![MyGet Nightly][opencensus-exporter-prom-myget-image]][opencensus-exporter-prom-myget-url] | [![NuGet release][opencensus-exporter-prom-nuget-image]][opencensus-exporter-prom-nuget-url] |
42+
| Application Insights | [![MyGet Nightly][opencensus-exporter-ai-myget-image]][opencensus-exporter-ai-myget-url] | [![NuGet release][opencensus-exporter-ai-nuget-image]][opencensus-exporter-ai-nuget-url] |
43+
| Stackdriver | [![MyGet Nightly][opencensus-exporter-stackdriver-myget-image]][opencensus-exporter-stackdriver-myget-url] | [![NuGet release][opencensus-exporter-stackdriver-nuget-image]][opencensus-exporter-stackdriver-nuget-url] |
44+
45+
## OpenCensus QuickStart: collecting data
46+
47+
You can use Open Census API to instrument code and report data. Or use one of
48+
automatic data collection modules.
49+
50+
### Using ASP.NET Core incoming requests collector
51+
52+
Incoming requests of ASP.NET Core app can be automatically tracked.
53+
54+
1. Install package to your project:
55+
[OpenCensus.Collector.AspNetCore][opencensus-collect-aspnetcore-nuget-url]
56+
57+
2. Make sure `ITracer`, `ISampler`, and `IPropagationComponent` registered in DI.
58+
``` csharp
59+
services.AddSingleton<ITracer>(Tracing.Tracer);
60+
services.AddSingleton<ISampler>(Samplers.AlwaysSample);
61+
services.AddSingleton<IPropagationComponent>(new DefaultPropagationComponent());
62+
```
63+
64+
3. Configure data collection singletons in ConfigureServices method:
65+
``` csharp
66+
public void ConfigureServices(IServiceCollection services)
67+
{
68+
// ...
69+
services.AddSingleton<RequestsCollectorOptions>(new RequestsCollectorOptions());
70+
services.AddSingleton<RequestsCollector>();
71+
```
72+
73+
4. Initiate data collection by instantiating singleton in Configure method
74+
``` csharp
75+
public void Configure(IApplicationBuilder app, /*... other arguments*/ )
76+
{
77+
// ...
78+
var collector = app.ApplicationServices.GetService<RequestsCollector>();
79+
```
80+
81+
### Using Dependencies collector
82+
83+
Outgoing http calls made by .NET Core `HttpClient` can be automatically tracked.
84+
85+
1. Install package to your project:
86+
[OpenCensus.Collector.Dependencies][opencensus-collect-deps-nuget-url]
87+
88+
2. Make sure `ITracer`, `ISampler`, and `IPropagationComponent` registered in DI.
89+
``` csharp
90+
services.AddSingleton<ITracer>(Tracing.Tracer);
91+
services.AddSingleton<ISampler>(Samplers.AlwaysSample);
92+
services.AddSingleton<IPropagationComponent>(new DefaultPropagationComponent());
93+
```
94+
95+
3. Configure data collection singletons in ConfigureServices method:
96+
``` csharp
97+
public void ConfigureServices(IServiceCollection services)
98+
{
99+
// ...
100+
services.AddSingleton<DependenciesCollectorOptions>(new DependenciesCollectorOptions());
101+
services.AddSingleton<DependenciesCollector>();
102+
```
103+
104+
4. Initiate data collection by instantiating singleton in Configure method
105+
``` csharp
106+
public void Configure(IApplicationBuilder app, /*... other arguments*/ )
107+
{
108+
// ...
109+
var depCollector = app.ApplicationServices.GetService<DependenciesCollector>();
110+
```
111+
112+
## OpenCensus QuickStart: exporting data
33113

34114
### Using Zipkin exporter
35115

@@ -142,12 +222,36 @@ deprecate it for 18 months before removing it, if possible.
142222
[gitter-url]:https://gitter.im/census-instrumentation/lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
143223
[opencensus-myget-image]:https://img.shields.io/myget/opencensus/vpre/OpenCensus.svg
144224
[opencensus-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus
225+
[opencensus-abs-myget-image]:https://img.shields.io/myget/opencensus/vpre/OpenCensus.Abstractions.svg
226+
[opencensus-abs-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus.Abstractions
145227
[opencensus-exporter-zipkin-myget-image]:https://img.shields.io/myget/opencensus/vpre/OpenCensus.Exporter.Zipkin.svg
146228
[opencensus-exporter-zipkin-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus.Exporter.Zipkin
229+
[opencensus-exporter-prom-myget-image]:https://img.shields.io/myget/opencensus/vpre/OpenCensus.Exporter.Prometheus.svg
230+
[opencensus-exporter-prom-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus.Exporter.Prometheus
147231
[opencensus-exporter-ai-myget-image]:https://img.shields.io/myget/opencensus/vpre/OpenCensus.Exporter.ApplicationInsights.svg
148232
[opencensus-exporter-ai-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus.Exporter.ApplicationInsights
149233
[opencensus-exporter-stackdriver-myget-image]:https://img.shields.io/myget/opencensus/vpre/OpenCensus.Exporter.Stackdriver.svg
150234
[opencensus-exporter-stackdriver-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus.Exporter.Stackdriver
235+
[opencensus-collect-aspnetcore-myget-image]:https://img.shields.io/myget/opencensus/vpre/OpenCensus.Collector.AspNetCore.svg
236+
[opencensus-collect-aspnetcore-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus.Collector.AspNetCore
237+
[opencensus-collect-deps-myget-image]:https://img.shields.io/myget/opencensus/vpre/OpenCensus.Collector.Dependencies.svg
238+
[opencensus-collect-deps-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus.Collector.Dependencies
239+
[opencensus-nuget-image]:https://img.shields.io/nuget/vpre/OpenCensus.svg
240+
[opencensus-nuget-url]:https://www.nuget.org/packages/OpenCensus
241+
[opencensus-abs-nuget-image]:https://img.shields.io/nuget/vpre/OpenCensus.Abstractions.svg
242+
[opencensus-abs-nuget-url]: https://www.nuget.org/packages/OpenCensus.Abstractions
243+
[opencensus-exporter-zipkin-nuget-image]:https://img.shields.io/nuget/vpre/OpenCensus.Exporter.Zipkin.svg
244+
[opencensus-exporter-zipkin-nuget-url]: https://www.nuget.org/packages/OpenCensus.Exporter.Zipkin
245+
[opencensus-exporter-prom-nuget-image]:https://img.shields.io/nuget/vpre/OpenCensus.Exporter.Prometheus.svg
246+
[opencensus-exporter-prom-nuget-url]: https://www.nuget.org/packages/OpenCensus.Exporter.Prometheus
247+
[opencensus-exporter-ai-nuget-image]:https://img.shields.io/nuget/vpre/OpenCensus.Exporter.ApplicationInsights.svg
248+
[opencensus-exporter-ai-nuget-url]: https://www.nuget.org/packages/OpenCensus.Exporter.ApplicationInsights
249+
[opencensus-exporter-stackdriver-nuget-image]:https://img.shields.io/nuget/vpre/OpenCensus.Exporter.Stackdriver.svg
250+
[opencensus-exporter-stackdriver-nuget-url]: https://www.nuget.org/packages/OpenCensus.Exporter.Stackdriver
251+
[opencensus-collect-aspnetcore-nuget-image]:https://img.shields.io/nuget/vpre/OpenCensus.Collector.AspNetCore.svg
252+
[opencensus-collect-aspnetcore-nuget-url]: https://www.nuget.org/packages/OpenCensus.Collector.AspNetCore
253+
[opencensus-collect-deps-nuget-image]:https://img.shields.io/nuget/vpre/OpenCensus.Collector.Dependencies.svg
254+
[opencensus-collect-deps-nuget-url]: https://www.nuget.org/packages/OpenCensus.Collector.Dependencies
151255
[up-for-grabs-issues]: https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs
152256
[good-first-issues]: https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
153257
[zipkin-get-started]: https://zipkin.io/pages/quickstart.html

0 commit comments

Comments
 (0)