Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

TypeScript definitions #308

Merged
merged 2 commits into from
Apr 6, 2021
+11,636 −71
Merged

TypeScript definitions #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
891d299
TypeScript definitions
antonvasin Aug 11, 2020
254c651
Merge remote-tracking branch 'origin/main' into typescript-definitions
vreynolds Apr 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 57 additions & 55 deletions docs/CustomContext.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,30 @@ in each of the examples below, the `customContext` usage is higlighted by a `/**
const honey = require("honeycomb-beeline")();

const express = require("express"),
React = require("react"),
ReactDOM = require("react-dom/server"),
User = require("./user"),
UserView = require("./views/user");

app.param('user', (req, res, next, id) => {
req.userId = id;
next();
React = require("react"),
ReactDOM = require("react-dom/server"),
User = require("./user"),
UserView = require("./views/user");

app.param("user", (req, res, next, id) => {
req.userId = id;
next();
});

app.get("/user/:user", (req, res, next) => {
// the underlying DB event called by User.find will _not_ contain the additional fields.
User.find(req.userId, (err, user) => {
if (err) {
return next(err);
}
/**/ honey.customContext.add("user.id", user.id);
/**/ honey.customContext.add("user.email", user.email);
// the underlying DB event called by User.find will _not_ contain the additional fields.
User.find(req.userId, (err, user) => {
if (err) {
return next(err);
}
/**/ honey.customContext.add("user.id", user.id);
/**/ honey.customContext.add("user.email", user.email);

// the express request event will contain the additional fields.
// the express request event will contain the additional fields.

// the react renderToString event here will also contain the additional fields.
res.send(ReactDOM.renderToString(React.createElement(UserView, { user })));
})
// the react renderToString event here will also contain the additional fields.
res.send(ReactDOM.renderToString(React.createElement(UserView, { user })));
});
});
```

Expand All @@ -59,29 +59,31 @@ app.get("/user/:user", (req, res, next) => {
const honey = require("honeycomb-beeline")();

const express = require("express"),
React = require("react"),
ReactDOM = require("react-dom/server"),
User = require("./user"),
UserView = require("./views/user");

app.param('user', (req, res, next, id) => {
req.userId = id;
next();
React = require("react"),
ReactDOM = require("react-dom/server"),
User = require("./user"),
UserView = require("./views/user");

app.param("user", (req, res, next, id) => {
req.userId = id;
next();
});

app.get("/user/:user", (req, res, next) => {
// the underlying DB event called by User.find will _not_ contain the additional fields.
User.find(req.userId).then(user => {
/**/ honey.customContext.add("user.id", user.id);
/**/ honey.customContext.add("user.email", user.email);
// the underlying DB event called by User.find will _not_ contain the additional fields.
User.find(req.userId)
.then((user) => {
/**/ honey.customContext.add("user.id", user.id);
/**/ honey.customContext.add("user.email", user.email);

// the express request event will contain the additional fields.
// the express request event will contain the additional fields.

// the react renderToString event here will also contain the additional fields.
res.send(ReactDOM.renderToString(React.createElement(UserView, { user })));
}).catch(err => {
return next(err);
// the react renderToString event here will also contain the additional fields.
res.send(ReactDOM.renderToString(React.createElement(UserView, { user })));
})
.catch((err) => {
return next(err);
});
});
```

Expand All @@ -91,31 +93,31 @@ app.get("/user/:user", (req, res, next) => {
const honey = require("honeycomb-beeline")();

const express = require("express"),
React = require("react"),
ReactDOM = require("react-dom/server"),
User = require("./user"),
UserView = require("./views/user");

app.param('user', (req, res, next, id) => {
req.userId = id;
next();
React = require("react"),
ReactDOM = require("react-dom/server"),
User = require("./user"),
UserView = require("./views/user");

app.param("user", (req, res, next, id) => {
req.userId = id;
next();
});

app.get("/user/:user", async (req, res, next) => {
try {
// the underlying DB event called by User.find will _not_ contain the additional fields.
let user = await User.find(req.userId);
try {
// the underlying DB event called by User.find will _not_ contain the additional fields.
let user = await User.find(req.userId);

/**/ honey.customContext.add("user.id", user.id);
/**/ honey.customContext.add("user.email", user.email);
/**/ honey.customContext.add("user.id", user.id);
/**/ honey.customContext.add("user.email", user.email);

// the express request event will contain the additional fields.
// the express request event will contain the additional fields.

// the react renderToString event here will also contain the additional fields.
res.send(ReactDOM.renderToString(React.createElement(UserView, { user })));
} catch(e) {
return next(e);
}
// the react renderToString event here will also contain the additional fields.
res.send(ReactDOM.renderToString(React.createElement(UserView, { user })));
} catch (e) {
return next(e);
}
});
```

Expand Down
180 changes: 180 additions & 0 deletions lib/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
import { IncomingMessage } from "http";

export interface SamplerResponse {
sampleRate: number;
shouldSample: boolean;
}

export interface BeelineOpts {
antonvasin marked this conversation as resolved.
Show resolved Hide resolved
writeKey?: string;
dataset?: string;
serviceName?: string;
sampleRate?: number;
enabledInstrumentations?: string[];

samplerHook?(event: unknown): SamplerResponse;
presendHook?(event: unknown): void;
disableInstrumentation?: boolean;

express?: {
userContext?: MetadataContext;
traceIdSource?: string | ((req: IncomingMessage) => string);
parentIdSource?: string | ((req: IncomingMessage) => string);
};

fastify?: {
userContext?: MetadataContext;
traceIdSource?: string | ((req: IncomingMessage) => string);
parentIdSource?: string | ((req: IncomingMessage) => string);
};

mongodb?: {
includeDocuments?: boolean;
};

httpTraceParserHook?: HttpTraceParserHook;
httpTracePropagationHook?: HttpTracePropagationHook;
}

export interface Schema {
"meta.type"?: string;
"meta.node_version"?: string;
"meta.beeline_version"?: string;
"meta.package"?: string;
"meta.package_version"?: string;
"meta.instrumentations"?: string;
"meta.instrumentation_count"?: string;
"meta.local_hostname"?: string;
duration_ms?: number;
"trace.trace_id"?: string;
"trace.trace_id_source"?: string;
"trace.parent_id"?: string;
"trace.span_id"?: string;
service_name?: string;
name?: string;
}

export interface Span {
addContext(metadataContext: MetadataContext): void;
payload: Schema & MetadataContext;
startTime: number;
startTimeHR: [number, number];
}

export type MetadataContext = Record<string, any>;

export interface TraceContext {
antonvasin marked this conversation as resolved.
Show resolved Hide resolved
traceId?: string;
parentSpanId?: string;
dataset?: string;
customContext?: MetadataContext;
source?: string;
}

export interface ExecutionContext {
id?: string;
traceContext?: MetadataContext;
stack?: Span[];
dataset?: string;
}

export type MarshallableContext = MetadataContext | ExecutionContext;

export interface Timer {
name: string;
startTimeHR: [number, number];
}

type SpanFn<F> = (...args: any[]) => F;

type Configure = (opts?: BeelineOpts) => Beeline & Configure;

type Headers = Record<string, string>;
export type HttpTraceParserHook = (req: IncomingMessage) => TraceContext;
export type HttpTracePropagationHook = (ctx: TraceContext) => Headers;

export interface Beeline {
traceActive(): boolean;
clearTrace(): void;
getTraceContext(): ExecutionContext;

startTrace(
metadataContext?: MetadataContext,
traceId?: string,
parentSpanId?: string,
dataset?: string,
propagatedContext?: MetadataContext
): Span | undefined;
finishTrace(trace: Span): void;
withTrace<F>(
metadataContext: MetadataContext,
fn: SpanFn<F>,
traceId?: string,
parentSpanId?: string,
dataset?: string
): F;

startSpan(metadataContext?: MetadataContext): Span | undefined;
finishSpan(event: Span, rollup?: string): void;
withSpan<F>(metadataContext: MetadataContext, fn: SpanFn<F>, rollup?: string): F;
startAsyncSpan<F>(metadataContext: MetadataContext, fn: SpanFn<F>): F;

startTimer(name: string): Timer;
finishTimer(timer: Timer): void;
withTimer<F>(name: string, fn: SpanFn<F>): F;

addTraceContext(metadataContext: MetadataContext): void;
addContext(metadataContext: MetadataContext): void;
/** @deprecated this method will be removed in the next major release. */
removeContext(key: string): void;

customContext: {
/** @deprecated this method will be removed in the next major release. Please use .addTraceContext. */
add(k: string, v: any): void;
/** @deprecated this method will be removed in the next major release. */
remove(k: string): void;
};

bindFunctionToTrace<F>(fn: SpanFn<F>): F;
runWithoutTrace<F>(fn: SpanFn<F>): F;

flush(): Promise<void>;

getInstrumentations(): string[];

/** @deprecated this method will be removed in the next major release. Please use honeycomb.marshalTraceContext() instead. */
marshalTraceContext(ctx: MarshallableContext): string;
/** @deprecated this method will be removed in the next major release. Please use honeycomb.unmarshalTraceContext() instead. */
unmarshalTraceContext(ctx: string): TraceContext | undefined;

honeycomb: {
marshalTraceContext(ctx: MarshallableContext): string;
unmarshalTraceContext(honeycombTraceHeader: string): TraceContext | undefined;
httpTraceParserHook: HttpTraceParserHook;
httpTracePropagationHook: HttpTracePropagationHook;
TRACE_HTTP_HEADER: string;
};

w3c: {
marshalTraceContext(ctx: MarshallableContext): string;
unmarshalTraceContext(traceparent: string, tracestate?: string): TraceContext | undefined;
httpTraceParserHook: HttpTraceParserHook;
httpTracePropagationHook: HttpTracePropagationHook;
TRACE_HTTP_HEADER: string;
};

aws: {
marshalTraceContext(ctx: MarshallableContext): string;
unmarshalTraceContext(amazonTraceHeader: string): TraceContext | undefined;
httpTraceParserHook: HttpTraceParserHook;
httpTracePropagationHook: HttpTracePropagationHook;
TRACE_HTTP_HEADER: string;
};

/** @deprecated this constant will be removed in the next major release. Please use honeycomb.TRACE_HTTP_HEADER instead. */
TRACE_HTTP_HEADER: string;
antonvasin marked this conversation as resolved.
Show resolved Hide resolved
}

declare const beeline: Beeline & Configure;

export default beeline;
Loading