Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

docs: Format example for tracer.startActiveSpan #101

Merged
merged 3 commits into from
Jul 26, 2021
Merged

docs: Format example for tracer.startActiveSpan #101

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
47a4757
docs: Format example for tracer.startActiveSpan
ad-m Jul 8, 2021
abef188
Merge branch 'main' into fix-example
vmarchaud Jul 8, 2021
c452067
Merge branch 'main' into fix-example
dyladan Jul 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
59 changes: 30 additions & 29 deletions src/trace/tracer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,36 +50,37 @@ export interface Tracer {
* @param fn function called in the context of the span and receives the newly created span as an argument
* @returns return value of fn
* @example
* const something = tracer.startActiveSpan('op', span => {
* try {
* do some work
* span.setStatus({code: SpanStatusCode.OK});
* return something;
* } catch (err) {
* span.setStatus({
* code: SpanStatusCode.ERROR,
* message: err.message,
* });
* throw err;
* } finally {
* span.end();
* }
* });
* const something = tracer.startActiveSpan('op', span => {
* try {
* do some work
* span.setStatus({code: SpanStatusCode.OK});
* return something;
* } catch (err) {
* span.setStatus({
* code: SpanStatusCode.ERROR,
* message: err.message,
* });
* throw err;
* } finally {
* span.end();
* }
* });
*
* @example
* const span = tracer.startActiveSpan('op', span => {
* try {
* do some work
* return span;
* } catch (err) {
* span.setStatus({
* code: SpanStatusCode.ERROR,
* message: err.message,
* });
* throw err;
* }
* });
* do some more work
* span.end();
* const span = tracer.startActiveSpan('op', span => {
* try {
* do some work
* return span;
* } catch (err) {
* span.setStatus({
* code: SpanStatusCode.ERROR,
* message: err.message,
* });
* throw err;
* }
* });
* do some more work
* span.end();
dyladan marked this conversation as resolved.
Show resolved Hide resolved
*/
startActiveSpan<F extends (span: Span) => unknown>(
name: string,
Expand Down