Alignment of span type/subtype

[SylvainJuge]

This is a meta-issue to describe all the known alignment issues/inconsistencies with span type / subtype

The current state of specification is stored in tests/agents/json-specs/span_types.json in JSON format.

For convenience, we will refer to span type & subtype as type/subtype.
This issue description will be modified when alignment progresses.

List of things that need improvement/simplification/alignment

• create a generic subtype in app for internal delegation that is not framework/library specific: we currently have app/mailer, app/controller, app/resource and app/graphql span type/subtype: alignment step 1 #513
• create a dedicated external/email for spans that send emails (would replace app/mailer)
• remove json/parse and json/generate as it's only used by ruby, span naming might be enough. deprecated in span type/subtype: alignment step 1 #513
• no strict specification for template/*, thus any value will be accepted as subtype, listing all known values for each platform is required to replace this with an exhaustive list, or we could replace it with a generic subtype.
• move websocket to external/websocket
• merge db/sqllite with db/sqlite3 deprecated in span type/subtype: alignment step 1 #513
• merge db/sqlserver and db/mssql deprecated in span type/subtype: alignment step 1 #513
• remove fields deprecated in span type/subtype: alignment step 1 #513

Process

1. Agent tests to enforce conformance to shared type/subtype name spec  #555

Agent	Add automated span type/subtype checking against shared spec
Java
dot-net
Go
PHP
Ruby
NodeJS
Python

2. add required type & subtypes the the JSON definition to make tests pass, open PRs (reviews optional)
3. When merging spec PRs, add known inconsistencies to the list above (if required)
4. discuss alignment through comments in this issue
5. goto step 2

[SylvainJuge]

@elastic/apm-agent-ruby there could be a few quick wins here:

• use external/email instead of app/mailer
• merge db/sqllite with db/sqlite3

For json/* I think we could use a generic subtype of app (the one we need to find a good name for), using span name should be enough for the end user to know it's about JSON read/write operations.

[mikker]

Completely agree, @SylvainJuge. Good ideas 👍

[SylvainJuge]

Proposal for internal delegation spans, simply call them app/internal (which would somehow align with Otel internal spans).

[SylvainJuge]

Adding app/internal for generic spans: #513 + few other alignment changes.