Skip to content

dependabit / action/src / Logger

Class: Logger ​

Defined in: packages/action/src/logger.ts:36

Structured JSON logger for GitHub Actions

Constructors ​

Constructor ​

ts
new Logger(config?): Logger;

Defined in: packages/action/src/logger.ts:41

Parameters ​

ParameterType
configLoggerConfig

Returns ​

Logger

Methods ​

child() ​

ts
child(context?): Logger;

Defined in: packages/action/src/logger.ts:124

Create a child logger with the same correlation ID

Parameters ​

ParameterType
context?Record<string, unknown>

Returns ​

Logger


debug() ​

ts
debug(message, data?): void;

Defined in: packages/action/src/logger.ts:73

Log debug message

Parameters ​

ParameterType
messagestring
data?Record<string, unknown>

Returns ​

void


endGroup() ​

ts
endGroup(): void;

Defined in: packages/action/src/logger.ts:110

End a log group

Returns ​

void


error() ​

ts
error(message, data?): void;

Defined in: packages/action/src/logger.ts:96

Log error message

Parameters ​

ParameterType
messagestring
data?Record<string, unknown>

Returns ​

void


getCorrelationId() ​

ts
getCorrelationId(): string;

Defined in: packages/action/src/logger.ts:117

Get correlation ID

Returns ​

string


info() ​

ts
info(message, data?): void;

Defined in: packages/action/src/logger.ts:82

Log info message

Parameters ​

ParameterType
messagestring
data?Record<string, unknown>

Returns ​

void


logAPICall() ​

ts
logAPICall(data): void;

Defined in: packages/action/src/logger.ts:152

Log API call

Parameters ​

ParameterType
data{ endpoint: string; latencyMs?: number; method: string; rateLimit?: { limit: number; remaining: number; reset: number; }; statusCode?: number; }
data.endpointstring
data.latencyMs?number
data.methodstring
data.rateLimit?{ limit: number; remaining: number; reset: number; }
data.rateLimit.limitnumber
data.rateLimit.remainingnumber
data.rateLimit.resetnumber
data.statusCode?number

Returns ​

void


logDuration() ​

ts
logDuration(
   operation, 
   durationMs, 
   data?): void;

Defined in: packages/action/src/logger.ts:172

Log operation duration

Parameters ​

ParameterType
operationstring
durationMsnumber
data?Record<string, unknown>

Returns ​

void


logLLMInteraction() ​

ts
logLLMInteraction(data): void;

Defined in: packages/action/src/logger.ts:135

Log LLM interaction

Parameters ​

ParameterType
data{ latencyMs?: number; model?: string; prompt: string; provider: string; response: string; tokens?: number; }
data.latencyMs?number
data.model?string
data.promptstring
data.providerstring
data.responsestring
data.tokens?number

Returns ​

void


startGroup() ​

ts
startGroup(name): void;

Defined in: packages/action/src/logger.ts:103

Start a log group

Parameters ​

ParameterType
namestring

Returns ​

void


warning() ​

ts
warning(message, data?): void;

Defined in: packages/action/src/logger.ts:89

Log warning message

Parameters ​

ParameterType
messagestring
data?Record<string, unknown>

Returns ​

void

Released under the MIT License.