Skip to content

Commit 682cee5

Browse files
author
Sergey Kanzhelev
committed
initial draft of sdk versions doc
1 parent 234d4f0 commit 682cee5

File tree

2 files changed

+144
-40
lines changed

2 files changed

+144
-40
lines changed

‎EndpointSpecs/SDK-AUTHORING.md

+2-40
Original file line numberDiff line numberDiff line change
@@ -24,44 +24,6 @@ At this point the v2-schema definition is not available however we are working o
2424

2525
An SDK author can validate data is conforming to authoring requirements by sending their payload to `https://dc.services.visualstudio.com/v2/validate`. Data sent to this endpoint will not be permenantly recorded.
2626

27-
## SDK Version Specification
27+
## SDK Versions
2828

29-
SDKs are required to include their name and version in the telemetry item using the `ai.internal.sdkVersion` tag conforming to the format below.
30-
31-
E.g.
32-
33-
```
34-
{
35-
"tags": {
36-
"ai.internal.sdkVersion:" "dotnet:2.0.0"
37-
}
38-
}
39-
```
40-
41-
### SDK Version Format
42-
43-
```
44-
[PREFIX_]SDKNAME:SEMVER
45-
```
46-
47-
| Section | Required | Description | Example |
48-
|------------------|----------|-------------------------------------------------------------------------|---------|
49-
| Prefix | No | An optional single lowercase letter (a-z) followed by an underscore (_) | a_ |
50-
| SDK Name | Yes | An alpha lowercase string (a-z) | dotnet |
51-
| Semantic Version | Yes | A [Semantic Versioning](http://semver.org/) compatible version string | 2.0.0 |
52-
53-
SDK name and semver are delmited by a single colon (:).
54-
55-
### Examples
56-
57-
```
58-
r_dotnet:2.0.0-12345
59-
dotnet:2.0.0-beta.1
60-
| ------ ------------
61-
| | |
62-
| | +-------> Semantic Version Format
63-
| |
64-
| +----------------> SDK Name
65-
|
66-
+---------------------> Prefix (optional)
67-
```
29+
See [SDK Versions](SDK-VERSIONS.md) for the information on how to report custom SDK version.

‎EndpointSpecs/SDK-VERSIONS.md

+142
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# SDK Version
2+
3+
SDK version is a field you can specify on every telemetry item. This field represent the specific SDK collected this particular item. This field is used for troubleshooting.
4+
5+
## SDK Version Specification
6+
7+
SDKs are required to include their name and version in the telemetry item using the `ai.internal.sdkVersion` tag conforming to the format below.
8+
9+
```
10+
{
11+
"tags": {
12+
"ai.internal.sdkVersion:" "dotnet:2.0.0"
13+
}
14+
}
15+
```
16+
17+
### SDK Version Format
18+
19+
```
20+
[PREFIX_]SDKNAME:SEMVER
21+
```
22+
23+
| Section | Required | Description | Example |
24+
|------------------|----------|-------------------------------------------------------------------------|---------|
25+
| Prefix | No | An optional single lowercase letter (a-z) followed by an underscore (_) | a_ |
26+
| SDK Name | Yes | An alpha lowercase string (a-z) | dotnet |
27+
| Semantic Version | Yes | A [Semantic Versioning](http://semver.org/) compatible version string | 2.0.0 |
28+
29+
SDK name and semver are delimited by a single colon (:).
30+
31+
### Examples
32+
33+
```
34+
r_dotnet:2.0.0-12345
35+
dotnet:2.0.0-beta.1
36+
| ------ ------------
37+
| | |
38+
| | +-------> Semantic Version Format
39+
| |
40+
| +----------------> SDK Name
41+
|
42+
+---------------------> Prefix (optional)
43+
```
44+
45+
## SDK Names
46+
47+
Define your own SDK name and send PR to update the list below. Please do not re-use the same SDK name.
48+
49+
### dotnet
50+
Base .NET SDK API was used to Track telemetry item, either manually, or from SDK that does not supply its own version.
51+
52+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet/releases
53+
54+
### rddf
55+
Remote dependency telemetry that was collected via Framework instrumentation (Event Source)
56+
57+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet-server/releases
58+
59+
### web
60+
telemetry that was collected by AI Web SDK, mostly is found on requests
61+
62+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet-server/releases
63+
64+
### rddp
65+
Remote dependency telemetry that was collected via Profiler instrumentation
66+
67+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet-server/releases
68+
69+
### rdddsd
70+
Remote dependency telemetry that was collected via Diagnostic Source instrumentation
71+
72+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet-server/releases
73+
74+
### pc
75+
performance counters
76+
77+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet-server/releases
78+
79+
### wcf
80+
WCF package from [labs](https://github.com/Microsoft/ApplicationInsights-sdk-labs) repository
81+
82+
### unobs
83+
unobserved exceptions - part of web SDK
84+
85+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet-server/releases
86+
87+
### unhnd
88+
unhandled exceptions – part of web SDK
89+
90+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet-server/releases
91+
92+
### azwapc
93+
azure web app performance counters
94+
95+
### sd
96+
System diagnostics trace
97+
98+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet-logging/releases
99+
100+
### nlog
101+
.NET Logging adapter nuget package for nlog
102+
103+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet-logging/releases
104+
105+
### log4net
106+
.NET logging adapter nuget package for log4net
107+
108+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet-logging/releases
109+
110+
### wad
111+
Windows Azure Diagnostics reporting through AI
112+
113+
### m-agg
114+
metric aggregation pipeline reported this metric
115+
116+
Public versions: https://github.com/Microsoft/ApplicationInsights-dotnet/releases
117+
118+
### node
119+
node.js SDK.
120+
121+
Public versions: https://github.com/Microsoft/ApplicationInsights-node.js/releases
122+
123+
### ios/ osx
124+
125+
### javascript
126+
JavaScript SDK.
127+
128+
Public versions: https://github.com/Microsoft/ApplicationInsights-js/releases
129+
130+
### android
131+
132+
### java
133+
java SDK.
134+
135+
Public versions: https://github.com/Microsoft/ApplicationInsights-java/releases
136+
137+
### aspnetv5
138+
ASP.NET core SDK
139+
140+
Public versions: https://github.com/Microsoft/ApplicationInsights-aspnetcore/releases
141+
142+
### hockeysdk

0 commit comments

Comments
 (0)