Export with OpenTelemetry

Send data from APImetrics to any platform that intakes OpenTelemetry with our OpenTelemetry Webhook

Our OpenTelemetry Webhook allows you to send your API traffic to any platform that allows OpenTelemetry, such as AWS, Azure, Datadog, & Splunk.

Create an OpenTelemetry Webhook

Go to the Alerting section of the sidebar and select Alerts & Webhooks.

From here, select the Add new alert button.

From here, you can name your new Webhook and choose the Type as OpenTelemetry.

You can now choose which API tags to Include and Exclude from the Webhook. To finish the setup, you will need to enter the URL for your desired platform and all HTTP Headers for the platform in their fields.

To finalise this Webhook, select the Save button and the Webhook will be finished.

Once saved, monitoring results will be passed to the target application starting from the next test call. The following attributes are included in the OTel span:

AttributeDescription
http.routeThe API call URL from the configuration
http.request.methodThe HTTP method
url.fullThe full URL called by the platform
http.response.statuscodeThe response HTTP code
client.addressThe source IP from which the call was made
custom.apimetrics_org_idThe ID of the Organization that owns the Project
custom.apimetrics_project_idThe ID of the Project that owns the API Call
custom.apimetrics_project_nameThe name of the Project
custom.apimetrics_call_idThe ID of the API Call
custom.apimetrics_call_nameThe name of the Project
custom.apimetrics_result_idThe ID of this Result
custom.apimetrics_agent_idThe platform agent ID which made the call
custom.apimetrics_cloudThe cloud from which the call was made
custom.apimetrics_cityThe city from which the call was made
custom.apimetrics_regionThe region from which the call was made
custom.apimetrics_countryThe country from which the call was made
custom.apimetrics_continentThe continent from which the call was made
custom.apimetrics_latitudeThe latitude from which the call was made
custom.apimetrics_longitudeThe longitude from which the call was made
tls.protocol.nameThe name of the TLS protocol through which the call was made
tls.protocol.versionThe version of the TLS protocol through which the call was made
tls.cipherThe cipher of the TLS protocol through which the call was made
tls.next_protocolThe next protocol of the TLS protocol through which the call was made
tls.server.certificate_chainThe chain of the TLS certificate of the endpoint called
tls.server.issuerThe issuer of the TLS certificate of the endpoint called
tls.server.subjectThe subject of the TLS certificate of the endpoint called
tls.server.not_beforeThe first valid date of the TLS certificate of the endpoint called
tls.server.not_afterThe last valid date of the TLS certificate of the endpoint called
tls.server.hash.md5The MD5 has of the TLS certificate of the endpoint called
tls.server.hash.sha1The SHA1 hash of the TLS certificate of the endpoint called
tls.server.hash.sha256The SHA256 hash of the TLS certificate of the endpoint called
tls.client.issuerThe client certificate issuer of the endpoint called (only populated if the call was configured to use mTLS)
tls.client.subjectThe client certificate subject of the endpoint called (only populated if the call was configured to use mTLS)
tls.client.not_beforeThe first valid date of the client certificate of the endpoint called (only populated if the call was configured to use mTLS)
tls.client.not_afterThe last valid date of the client certificate of the endpoint called (only populated if the call was configured to use mTLS)

Each result is split up into the following spans for timing information:

SpanDescription
dnsTime taken for DNS lookup
connectTime taken for network connection
tls_handshakeTime taken for network handshake
uploadTime taken to upload the request
processingTime taken for the server to process the request (time to first byte)
downloadTime taken for the download to complete (time to last byte)

When running as part of a Workflow, each result also has a parent span for all results in that workflow. The workflow span has the following attributes:

AttributeDescription
custom.apimetrics_org_idThe ID of the Organization that owns the Project
custom.apimetrics_project_idThe ID of the Project that owns the API Call
custom.apimetrics_project_nameThe name of the Project
custom.apimetrics_workflow_idThe ID of the Workflow
custom.apimetrics_workflow_nameThe name of the Workflow
custom.apimetrics_workflow_result_idThe ID of this Workflow result