File size: 5,331 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
/**
* Contains predefined constants for the trace span name in next/server.
*
* Currently, next/server/tracer is internal implementation only for tracking
* next.js's implementation only with known span names defined here.
**/
// eslint typescript has a bug with TS enums
/* eslint-disable no-shadow */
enum BaseServerSpan {
handleRequest = 'BaseServer.handleRequest',
run = 'BaseServer.run',
pipe = 'BaseServer.pipe',
getStaticHTML = 'BaseServer.getStaticHTML',
render = 'BaseServer.render',
renderToResponseWithComponents = 'BaseServer.renderToResponseWithComponents',
renderToResponse = 'BaseServer.renderToResponse',
renderToHTML = 'BaseServer.renderToHTML',
renderError = 'BaseServer.renderError',
renderErrorToResponse = 'BaseServer.renderErrorToResponse',
renderErrorToHTML = 'BaseServer.renderErrorToHTML',
render404 = 'BaseServer.render404',
}
enum LoadComponentsSpan {
loadDefaultErrorComponents = 'LoadComponents.loadDefaultErrorComponents',
loadComponents = 'LoadComponents.loadComponents',
}
enum NextServerSpan {
getRequestHandler = 'NextServer.getRequestHandler',
getServer = 'NextServer.getServer',
getServerRequestHandler = 'NextServer.getServerRequestHandler',
createServer = 'createServer.createServer',
}
enum NextNodeServerSpan {
compression = 'NextNodeServer.compression',
getBuildId = 'NextNodeServer.getBuildId',
createComponentTree = 'NextNodeServer.createComponentTree',
clientComponentLoading = 'NextNodeServer.clientComponentLoading',
getLayoutOrPageModule = 'NextNodeServer.getLayoutOrPageModule',
generateStaticRoutes = 'NextNodeServer.generateStaticRoutes',
generateFsStaticRoutes = 'NextNodeServer.generateFsStaticRoutes',
generatePublicRoutes = 'NextNodeServer.generatePublicRoutes',
generateImageRoutes = 'NextNodeServer.generateImageRoutes.route',
sendRenderResult = 'NextNodeServer.sendRenderResult',
proxyRequest = 'NextNodeServer.proxyRequest',
runApi = 'NextNodeServer.runApi',
render = 'NextNodeServer.render',
renderHTML = 'NextNodeServer.renderHTML',
imageOptimizer = 'NextNodeServer.imageOptimizer',
getPagePath = 'NextNodeServer.getPagePath',
getRoutesManifest = 'NextNodeServer.getRoutesManifest',
findPageComponents = 'NextNodeServer.findPageComponents',
getFontManifest = 'NextNodeServer.getFontManifest',
getServerComponentManifest = 'NextNodeServer.getServerComponentManifest',
getRequestHandler = 'NextNodeServer.getRequestHandler',
renderToHTML = 'NextNodeServer.renderToHTML',
renderError = 'NextNodeServer.renderError',
renderErrorToHTML = 'NextNodeServer.renderErrorToHTML',
render404 = 'NextNodeServer.render404',
startResponse = 'NextNodeServer.startResponse',
// nested inner span, does not require parent scope name
route = 'route',
onProxyReq = 'onProxyReq',
apiResolver = 'apiResolver',
internalFetch = 'internalFetch',
}
enum StartServerSpan {
startServer = 'startServer.startServer',
}
enum RenderSpan {
getServerSideProps = 'Render.getServerSideProps',
getStaticProps = 'Render.getStaticProps',
renderToString = 'Render.renderToString',
renderDocument = 'Render.renderDocument',
createBodyResult = 'Render.createBodyResult',
}
enum AppRenderSpan {
renderToString = 'AppRender.renderToString',
renderToReadableStream = 'AppRender.renderToReadableStream',
getBodyResult = 'AppRender.getBodyResult',
fetch = 'AppRender.fetch',
}
enum RouterSpan {
executeRoute = 'Router.executeRoute',
}
enum NodeSpan {
runHandler = 'Node.runHandler',
}
enum AppRouteRouteHandlersSpan {
runHandler = 'AppRouteRouteHandlers.runHandler',
}
enum ResolveMetadataSpan {
generateMetadata = 'ResolveMetadata.generateMetadata',
generateViewport = 'ResolveMetadata.generateViewport',
}
enum MiddlewareSpan {
execute = 'Middleware.execute',
}
type SpanTypes =
| `${BaseServerSpan}`
| `${LoadComponentsSpan}`
| `${NextServerSpan}`
| `${StartServerSpan}`
| `${NextNodeServerSpan}`
| `${RenderSpan}`
| `${RouterSpan}`
| `${AppRenderSpan}`
| `${NodeSpan}`
| `${AppRouteRouteHandlersSpan}`
| `${ResolveMetadataSpan}`
| `${MiddlewareSpan}`
// This list is used to filter out spans that are not relevant to the user
export const NextVanillaSpanAllowlist = [
MiddlewareSpan.execute,
BaseServerSpan.handleRequest,
RenderSpan.getServerSideProps,
RenderSpan.getStaticProps,
AppRenderSpan.fetch,
AppRenderSpan.getBodyResult,
RenderSpan.renderDocument,
NodeSpan.runHandler,
AppRouteRouteHandlersSpan.runHandler,
ResolveMetadataSpan.generateMetadata,
ResolveMetadataSpan.generateViewport,
NextNodeServerSpan.createComponentTree,
NextNodeServerSpan.findPageComponents,
NextNodeServerSpan.getLayoutOrPageModule,
NextNodeServerSpan.startResponse,
NextNodeServerSpan.clientComponentLoading,
]
// These Spans are allowed to be always logged
// when the otel log prefix env is set
export const LogSpanAllowList = [
NextNodeServerSpan.findPageComponents,
NextNodeServerSpan.createComponentTree,
NextNodeServerSpan.clientComponentLoading,
]
export {
BaseServerSpan,
LoadComponentsSpan,
NextServerSpan,
NextNodeServerSpan,
StartServerSpan,
RenderSpan,
RouterSpan,
AppRenderSpan,
NodeSpan,
AppRouteRouteHandlersSpan,
ResolveMetadataSpan,
MiddlewareSpan,
}
export type { SpanTypes }
|