[XMLHttpRequestInstrumentation] Ability to control what span events are being monitored

[tl-sebastien-kovacs]

Hi Team,

I'm trying to setup XMLHttpRequestInstrumentation for one of our web-app and I'd be keen to understand if it's possible to filter out some / all events.
The main reason for it is because we are using a 3rd party tool (honeycomb.io) and we are charged per span event.

Thank you !

Here is the instrumentation config:

  registerInstrumentations({
    instrumentations: [
      new XMLHttpRequestInstrumentation({
        ignoreUrls: [/localhost/],
      }),
    ],
  })

I've also attached a resource span example:

{
    "resourceSpans": [
        {
            "resource": {
                "attributes": [
                    {
                        "key": "service.name",
                        "value": {
                            "stringValue": "my-web-app"
                        }
                    },
                    {
                        "key": "telemetry.sdk.language",
                        "value": {
                            "stringValue": "webjs"
                        }
                    },
                    {
                        "key": "telemetry.sdk.name",
                        "value": {
                            "stringValue": "opentelemetry"
                        }
                    },
                    {
                        "key": "telemetry.sdk.version",
                        "value": {
                            "stringValue": "1.0.1"
                        }
                    }
                ],
                "droppedAttributesCount": 0
            },
            "instrumentationLibrarySpans": [
                {
                    "spans": [
                        {
                            "traceId": "9d7057606d5dff004d41b82684bb9024",
                            "spanId": "18494d771fcf53b6",
                            "name": "HTTP GET",
                            "kind": 3,
                            "startTimeUnixNano": 1645628055647700000,
                            "endTimeUnixNano": 1645628055733100000,
                            "attributes": [
                                {
                                    "key": "http.method",
                                    "value": {
                                        "stringValue": "GET"
                                    }
                                },
                                {
                                    "key": "http.url",
                                    "value": {
                                        "stringValue": "https://some-api.com"
                                    }
                                },
                                {
                                    "key": "http.response_content_length",
                                    "value": {
                                        "intValue": 0
                                    }
                                },
                                {
                                    "key": "http.status_code",
                                    "value": {
                                        "intValue": 200
                                    }
                                },
                                {
                                    "key": "http.status_text",
                                    "value": {
                                        "stringValue": "OK"
                                    }
                                },
                                {
                                    "key": "http.host",
                                    "value": {
                                        "stringValue": "some-api.com"
                                    }
                                },
                                {
                                    "key": "http.scheme",
                                    "value": {
                                        "stringValue": "https"
                                    }
                                },
                                {
                                    "key": "http.user_agent",
                                    "value": {
                                        "stringValue": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.80 Safari/537.36"
                                    }
                                }
                            ],
                            "droppedAttributesCount": 0,
                            "events": [
                                {
                                    "timeUnixNano": 1645628055648000000,
                                    "name": "open",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628055648900000,
                                    "name": "send",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628055709500000,
                                    "name": "fetchStart",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628054267200000,
                                    "name": "domainLookupStart",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628054267200000,
                                    "name": "domainLookupEnd",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628054267200000,
                                    "name": "connectStart",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628054267200000,
                                    "name": "secureConnectionStart",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628054267200000,
                                    "name": "connectEnd",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628054267200000,
                                    "name": "requestStart",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628054267200000,
                                    "name": "responseStart",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628055732100000,
                                    "name": "responseEnd",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                },
                                {
                                    "timeUnixNano": 1645628055733100000,
                                    "name": "loaded",
                                    "attributes": [],
                                    "droppedAttributesCount": 0
                                }
                            ],
                            "droppedEventsCount": 0,
                            "status": {
                                "code": 0
                            },
                            "links": [],
                            "droppedLinksCount": 0
                        }
                    ],
                    "instrumentationLibrary": {
                        "name": "@opentelemetry/instrumentation-xml-http-request",
                        "version": "0.27.0"
                    }
                }
            ]
        }
    ]
}

[dyladan]

Right now there is no way to do this, but there are things you could implement like a custom SpanProcessor. you could also instrument manually if you only need to capture certain info.

[vmarchaud]

For reference transforming spans before export is also discuted there (like suggested daniel, using a custom span processor)

[tl-sebastien-kovacs]

Thank you both.