[Enh]: Telemetry in `application_name`

[JerryNixon]

What

MSSQL telemetry in the application_name

Format

dab_oss_1.2.3.4+<context-settings>|<general-settings>|<runtime-settings>|<entity-settings>

Note

Sections are additive. New telemetry can be added at the end, before the |, for backwards compat.

Example

dab_oss_1.2.3.4+RTPAA|11111M10|10111101M|111110111001M1+

Important

If a client provides an application_name longer than 128 characters, SQL Server silently truncates it to 128.

Telemetry Schema

Any value indicates the encoding logic.

Context Settings

Ordinal	Property	Values
1	Protocol	R=REST, G=GraphQL, M=MCP
2	Object	T=Table, V=View, S=Stored Proc, P=Persisted Doc
3	Source	S=SQL, D=DWSQL, P=Postgres, M=MySQL, C=Cosmos
4	Role	N=Anonymous, A=Authenticated, C=Custom

RUNTIME Settings

Ordinal	Property	Values
1	runtime.rest.enabled	0/1/M
2	runtime.graphql.enabled	0/1/M
3	runtime.mcp.enabled	0/1/M
4	runtime.host.mode	0=Dev, 1=Prod, M=Missing
5	data-source-files	0/1/M
6	azure-key-vault	0/1/M
7	health.enabled	0/1/M
8	cache.enabled	0/1/M
9	cache.l2	0/1/M
10	data-source.obo	0/1/M
11	autoentities (at least one definition)	0/1/M
12	rest.request-body-strict	0/1/M
13	graphql.multiple-mutations.create.enabled	0/1/M
14	telemetry.open-telemetry.enabled	0/1/M
15	telemetry.application-insights.enabled	0/1/M
16	telemetry.azure-log-analytics.enabled	0/1/M
17	telemetry.file-sink.enabled	0/1/M
18	auth.provider	U E C S A W
19	embedding.enabled	0/1/M
20	embedding.endpoint.enabled	0/1/M

Entity Settings

Ordinal	Property	Values
1	Entities: any use table	0/1/M
2	Entities: any use view	0/1/M
3	Entities: any use stored procedures	0/1/M
4	Entities: any use MCP persisted documents	0/1/M/?
5	Entities: any use cache	0/1/M
6	Entities: any rest.enabled	0/1/M
7	Entities: any graphql.enabled	0/1/M
8	Entities: any use MCP dml-tools	0/1/M
9	Entities: any use MCP custom-tool	0/1/M
10	Entities: any use custom roles	0/1/M
11	Entities: any use policies	0/1/M
12	Entities: any use descriptions	0/1/M
13	Entities: any use relationships	0/1/M
14	Entities: any parameter use embed	0/1/M/?

Command line

dab appname --config dab-config.json

there is no context to present
output: dab_oss_1.2.3.4+XXXXX|11111M10|10111101M|111110111001M1+

dab appname --decode dab_oss_1.2.3.4+RTPAA|11111M10|10111101M|111110111001M1+

R > REST
T > table
P > Postgres
A > Application
...

• CLI must first run dab validate?
• When --output is omitted, the output is simply Console.Write.
• Decode must be tolerant in the event that app_name was truncated for some reason.

[JerryNixon]

Logging

• When the telemetry string is calculated, emit as Debug

Telemetry app_name is dab_oss_1.2.3.4+RTPAA|11111M10|10111101M|111110111001M1+

Hot reload

• Not relevant. Hot reload will already work.
• But ALWAYS check the ENVIRONMENT variable every time
• Do not recalc the string unless the Connection pool opens.

New pools

1. Only create the telemetry string once per pool
2. Figure out the pool logic and create a new string for each (only once)

Scope

Any source that has application_name

1. MSSQL = true
2. postgres = true
3. MySQL = false
4. Cosmos = false

Structure precedence

128 {OBO-hash (22)};{User-custom (0-104)};{DAB-telemetry}
128 {OBO-hash (22)};{User-custom (0-44)};{DAB-telemetry (60)}

DAB_APP_NAME_ENV

Depending on what it does, we will ignore it.

Opt-out?

Env Var DAB_TELEMETRY_APPNAME_OPT_OUT = 1

• When 1 then dab_oss_1.2.3
• When 0 then dab_oss_1.2.3+XYZ+
• When MISSING or INVALID then dab_oss_1.2.3+XYZ+