Index

src/tracing-policy.ts

alwaysTrace
alwaysTrace()
Returns : BuiltinTracePolicy
neverTrace
neverTrace()
Returns : BuiltinTracePolicy

src/plugins/plugin-connect.ts

createMiddleware
createMiddleware(api)
Parameters :
Name Optional
api No
Returns : connect_3.NextHandleFunction

src/plugins/plugin-koa.ts

createMiddleware
createMiddleware(api)
Parameters :
Name Optional
api No
Returns : koa_1.Middleware
createMiddleware2x
createMiddleware2x(api)
Parameters :
Name Optional
api No
Returns : koa_2.Middleware
patchUse
patchUse(koa, api, createMiddlewareFunction)
Parameters :
Name Optional
koa No
api No
createMiddlewareFunction No
startSpanForRequest
startSpanForRequest(api, ctx, getNext)
Parameters :
Name Optional
api No
ctx No
getNext No
Returns : T

src/span-data.ts

createPhantomSpanData
createPhantomSpanData(spanType)
Parameters :
Name Optional
spanType No
randomSpanId
randomSpanId()

src/util.ts

createStackTrace
createStackTrace(numFrames, skipFrames, constructorOpt?)

Creates a StackFrame object containing a structured stack trace.

Parameters :
Name Optional Description
numFrames No

The number of frames to retain.

skipFrames No

The number of top-most frames to remove.

constructorOpt Yes

A function passed to Error.captureStackTrace, which causes it to ignore the frames above the top-most call to this function.

Returns : StackFrame[]
deserializeTraceContext
deserializeTraceContext(buffer)

Deseralize the given trace context from binary encoding. If the input is a Buffer of incorrect size or unexpected fields, then this function will return null.

Parameters :
Name Optional Description
buffer No

The trace context to deserialize.

Returns : TraceContext | null
generateTraceContext
generateTraceContext(traceContext)

Generates a trace context header value that can be used to follow the associated request through other Google services.

Parameters :
Name Optional Description
traceContext No

An object with information sufficient for creating a serialized trace context.

Returns : string
lastOf
lastOf(defaultValue, ...otherValues: undefined)

Returns the last parameter that is not null, undefined, or NaN.

Parameters :
Name Optional Description
defaultValue No

The first parameter. This must not be null/undefined/NaN.

otherValues No

Other parameters, which may be null/undefined/NaN.

Returns : T
packageNameFromPath
packageNameFromPath(importPath)

Retrieves a package name from the full import path. For example: './node_modules/bar/index/foo.js' => 'bar'

Parameters :
Name Optional
importPath No
parseContextFromHeader
parseContextFromHeader(str)

Parse a cookie-style header string to extract traceId, spandId and options ex: '123456/667;o=3' -> {traceId: '123456', spanId: '667', options: '3'} note that we ignore trailing garbage if there is more than one '=' Returns null if traceId or spanId could not be found.

Parameters :
Name Optional Description
str No

string representation of the trace headers

Returns : TraceContext | null

object with keys. null if there is a problem.

serializeTraceContext
serializeTraceContext(traceContext)

Serialize the given trace context into a Buffer.

Parameters :
Name Optional Description
traceContext No

The trace context to serialize.

Returns : Buffer
truncate
truncate(str, length)

Truncates the provided string to be at most length bytes after utf8 encoding and the appending of '...'. We produce the result by iterating over input characters to avoid truncating the string potentially producing partial unicode characters at the end.

Parameters :
Name Optional
str No
length No

src/plugins/plugin-http2.ts

extractMethodName
extractMethodName(headers?)
Parameters :
Name Optional
headers Yes
Returns : string
extractPath
extractPath(headers?)
Parameters :
Name Optional
headers Yes
Returns : string
extractUrl
extractUrl(authority, headers?)
Parameters :
Name Optional
authority No
headers Yes
Returns : string
getSpanName
getSpanName(authority)
Parameters :
Name Optional
authority No
Returns : string
isTraceAgentRequest
isTraceAgentRequest(headers, api)
Parameters :
Name Optional
headers No
api No
Returns : boolean
makeRequestTrace
makeRequestTrace(request, authority, api)
Parameters :
Name Optional
request No
authority No
api No
patchHttp2
patchHttp2(h2, api)
Parameters :
Name Optional
h2 No
api No
Returns : void
patchHttp2Session
patchHttp2Session(session, authority, api)
Parameters :
Name Optional
session No
authority No
api No
Returns : void
unpatchHttp2
unpatchHttp2(h2)
Parameters :
Name Optional
h2 No

src/plugins/plugin-http.ts

extractUrl
extractUrl(options, fallbackProtocol)
Parameters :
Name Optional
options No
fallbackProtocol No
getSpanName
getSpanName(options)
Parameters :
Name Optional
options No
hasExpectHeader
hasExpectHeader(options)

Returns whether the Expect header is on the given options object. Assumes only that the header key is either capitalized, lowercase, or all-caps for simplicity purposes.

Parameters :
Name Optional Description
options No

Options for http.request.

Returns : boolean
isTraceAgentRequest
isTraceAgentRequest(options, api)
Parameters :
Name Optional
options No
api No
makeRequestTrace
makeRequestTrace(protocol, request, api)
Parameters :
Name Optional
protocol No
request No
api No
Returns : RequestFunction
patchHttp
patchHttp(http, api)
Parameters :
Name Optional
http No
api No
patchHttps
patchHttps(https, api)
Parameters :
Name Optional
https No
api No
unpatchHttp
unpatchHttp(http)
Parameters :
Name Optional
http No
unpatchHttps
unpatchHttps(https)
Parameters :
Name Optional
https No
urlToOptions
urlToOptions(url)
Parameters :
Name Optional
url No
Returns : httpModule.RequestOptions

src/index.ts

get
get()

Get the previously created StackdriverTracer object.

Returns : PluginTypes.Tracer

An object exposing functions for creating custom spans.

initConfig
initConfig(userConfig)

Normalizes the user-provided configuration object by adding default values and overriding with env variables when they are provided.

Parameters :
Name Optional Description
userConfig No

The user-provided configuration object. It will not be modified.

Returns : TopLevelConfig

A normalized configuration object.

start
start(config?)

Start the Stackdriver Trace Agent with the given configuration (if provided). This function should only be called once, and before any other modules are loaded.

Parameters :
Name Optional Description
config Yes

A configuration object.

Example :
trace.start();
Returns : PluginTypes.Tracer

An object exposing functions for creating custom spans.

src/plugins/plugin-hapi.ts

instrument
instrument(api, request, continueCb)
Parameters :
Name Optional
api No
request No
continueCb No
Returns : T

src/logger.ts

logLevelToName
logLevelToName(level?)
Parameters :
Name Optional
level Yes
Returns : LogLevel

src/plugins/plugin-grpc.ts

patchClient
patchClient(client, api)
Parameters :
Name Optional
client No
api No
patchMetadata
patchMetadata(metadata)
Parameters :
Name Optional
metadata No
patchServer
patchServer(server, api)
Parameters :
Name Optional
server No
api No
unpatchClient
unpatchClient(client)
Parameters :
Name Optional
client No
unpatchMetadata
unpatchMetadata()
unpatchServer
unpatchServer(server)
Parameters :
Name Optional
server No

src/plugins/plugin-express.ts

patchModuleRoot
patchModuleRoot(express, api)
Parameters :
Name Optional
express No
api No
unpatchModuleRoot
unpatchModuleRoot(express)
Parameters :
Name Optional
express No

src/plugins/plugin-restify.ts

patchRestify
patchRestify(restify, api)
Parameters :
Name Optional
restify No
api No
unpatchRestify
unpatchRestify(restify)
Parameters :
Name Optional
restify No

src/plugins/plugin-pg.ts

populateLabelsFromInputs
populateLabelsFromInputs(span, args)
Parameters :
Name Optional
span No
args No
populateLabelsFromOutputs
populateLabelsFromOutputs(span, err, res?)
Parameters :
Name Optional
span No
err No
res Yes

result-matching ""

    No results matching ""