|
| 1 | +const { trace } = require("@opentelemetry/api"); |
| 2 | +const { |
| 3 | + ATTR_HTTP_ROUTE, |
| 4 | + ATTR_URL_FULL, |
| 5 | + ATTR_USER_AGENT_ORIGINAL, |
| 6 | + ATTR_HTTP_REQUEST_METHOD, |
| 7 | + ATTR_NETWORK_PROTOCOL_NAME, |
| 8 | + ATTR_NETWORK_PROTOCOL_VERSION, |
| 9 | +} = require("@opentelemetry/semantic-conventions"); |
| 10 | +const { |
| 11 | + ATTR_HTTP_USER_AGENT, |
| 12 | + ATTR_HTTP_FLAVOR, |
| 13 | +} = require("@opentelemetry/semantic-conventions/incubating"); |
| 14 | + |
| 15 | +const isApiGwEvent = (event) => { |
| 16 | + return ( |
| 17 | + event?.requestContext?.domainName != null && |
| 18 | + event?.requestContext?.requestId != null |
| 19 | + ); |
| 20 | +}; |
| 21 | + |
| 22 | +const isSnsEvent = (event) => { |
| 23 | + return event?.Records?.[0]?.EventSource === "aws:sns"; |
| 24 | +}; |
| 25 | + |
| 26 | +const isSqsEvent = (event) => { |
| 27 | + return event?.Records?.[0]?.eventSource === "aws:sqs"; |
| 28 | +}; |
| 29 | + |
| 30 | +const isS3Event = (event) => { |
| 31 | + return event?.Records?.[0]?.eventSource === "aws:s3"; |
| 32 | +}; |
| 33 | + |
| 34 | +const isDDBEvent = (event) => { |
| 35 | + return event?.Records?.[0]?.eventSource === "aws:dynamodb"; |
| 36 | +}; |
| 37 | + |
| 38 | +const isCloudfrontEvent = (event) => { |
| 39 | + return event?.Records?.[0]?.cf?.config?.distributionId != null; |
| 40 | +}; |
| 41 | + |
| 42 | +const getFullUrl = (event) => { |
| 43 | + if (!event.headers) return undefined; |
| 44 | + function findAny(event, key1, key2) { |
| 45 | + return event.headers[key1] ?? event.headers[key2]; |
| 46 | + } |
| 47 | + const host = findAny(event, "host", "Host"); |
| 48 | + const proto = findAny(event, "x-forwarded-proto", "X-Forwarded-Proto"); |
| 49 | + const port = findAny(event, "x-forwarded-port", "X-Forwarded-Port"); |
| 50 | + if (!(proto && host && (event.path || event.rawPath))) { |
| 51 | + return undefined; |
| 52 | + } |
| 53 | + let answer = proto + "://" + host; |
| 54 | + if (port) { |
| 55 | + answer += ":" + port; |
| 56 | + } |
| 57 | + answer += event.path ?? event.rawPath; |
| 58 | + if (event.queryStringParameters) { |
| 59 | + let first = true; |
| 60 | + for (const key in event.queryStringParameters) { |
| 61 | + answer += first ? "?" : "&"; |
| 62 | + answer += encodeURIComponent(key); |
| 63 | + answer += "="; |
| 64 | + answer += encodeURIComponent(event.queryStringParameters[key]); |
| 65 | + first = false; |
| 66 | + } |
| 67 | + } |
| 68 | + return answer; |
| 69 | +}; |
| 70 | + |
| 71 | +class OpenTelemetry { |
| 72 | + static _getSpan() { |
| 73 | + return trace.getActiveSpan(); |
| 74 | + } |
| 75 | + |
| 76 | + static setSpanAttribute(key, value) { |
| 77 | + const span = this._getSpan(); |
| 78 | + if (span) span.setAttribute(key, value); |
| 79 | + } |
| 80 | + |
| 81 | + static addSpanRequestAttributes(event) { |
| 82 | + try { |
| 83 | + const span = this._getSpan(); |
| 84 | + if (!span) return; |
| 85 | + |
| 86 | + if (isApiGwEvent(event)) { |
| 87 | + const fullUrl = getFullUrl(event); |
| 88 | + span.setAttribute(ATTR_HTTP_ROUTE, event.routeKey?.split(" ")[1]); |
| 89 | + fullUrl && span.setAttribute(ATTR_URL_FULL, fullUrl); |
| 90 | + span.setAttribute( |
| 91 | + ATTR_HTTP_REQUEST_METHOD, |
| 92 | + event.requestContext?.http?.method, |
| 93 | + ); |
| 94 | + span.setAttribute( |
| 95 | + ATTR_USER_AGENT_ORIGINAL, |
| 96 | + event.requestContext?.http?.userAgent, |
| 97 | + ); |
| 98 | + span.setAttribute(ATTR_NETWORK_PROTOCOL_NAME, "http"); |
| 99 | + span.setAttribute( |
| 100 | + ATTR_NETWORK_PROTOCOL_VERSION, |
| 101 | + event.requestContext?.http?.protocol?.split("/")?.[1], |
| 102 | + ); |
| 103 | + span.setAttribute("http.request.id", event.requestContext?.requestId); |
| 104 | + span.setAttribute( |
| 105 | + "http.request.header.content-type", |
| 106 | + event.headers?.["content-type"], |
| 107 | + ); |
| 108 | + span.setAttribute("http.request.body_size", event.body?.length || 0); |
| 109 | + span.setAttribute("url.path", event.rawPath); |
| 110 | + span.setAttribute("url.query", event.rawQueryString); |
| 111 | + if (event.requestContext?.authorizer?.jwt?.claims) { |
| 112 | + const { claims } = event.requestContext.authorizer.jwt; |
| 113 | + span.setAttribute("user.id", claims.sub || claims.id); |
| 114 | + span.setAttribute("user.auth_method", "jwt"); |
| 115 | + span.setAttribute( |
| 116 | + "user.role", |
| 117 | + claims.role || claims["cognito:groups"], |
| 118 | + ); |
| 119 | + if (claims.event_id?.includes("Parent=")) { |
| 120 | + const parentTraceId = claims.event_id |
| 121 | + .split("Parent=")?.[1] |
| 122 | + ?.split(";")?.[0]; |
| 123 | + span.setAttribute("user.auth_parent_trace_id", parentTraceId); |
| 124 | + } |
| 125 | + } |
| 126 | + } |
| 127 | + |
| 128 | + // TODO: deal with other event types (S3, SQS, SNS, etc.) |
| 129 | + } catch (e) { |
| 130 | + console.debug("Error in addSpanRequestAttributes", e); |
| 131 | + } |
| 132 | + } |
| 133 | + |
| 134 | + static addSpanResponseAttributes(event, response) { |
| 135 | + try { |
| 136 | + const span = this._getSpan(); |
| 137 | + if (!span) return; |
| 138 | + |
| 139 | + if (isApiGwEvent(event)) { |
| 140 | + span.setAttribute("http.response.status_code", response.statusCode); |
| 141 | + span.setAttribute( |
| 142 | + "http.response.header.content-type", |
| 143 | + response.headers?.["content-type"] || |
| 144 | + response.headers?.["Content-Type"], |
| 145 | + ); |
| 146 | + span.setAttribute( |
| 147 | + "http.response.body_size", |
| 148 | + response.body?.length || 0, |
| 149 | + ); |
| 150 | + } |
| 151 | + } catch (e) { |
| 152 | + console.debug("Error in addSpanResponseAttributes", e); |
| 153 | + } |
| 154 | + } |
| 155 | + |
| 156 | + static addSpanErrorAttributes(event, error) { |
| 157 | + try { |
| 158 | + const span = this._getSpan(); |
| 159 | + if (!span) return; |
| 160 | + |
| 161 | + span.setAttribute("error", true); |
| 162 | + span.setAttribute("exception.message", error.message); |
| 163 | + span.setAttribute("exception.type", error.name); |
| 164 | + span.setAttribute("exception.stacktrace", error.stack); |
| 165 | + } catch (e) { |
| 166 | + console.debug("Error in addSpanErrorAttributes", e); |
| 167 | + } |
| 168 | + } |
| 169 | +} |
| 170 | + |
| 171 | +module.exports = OpenTelemetry; |
0 commit comments