tf6serverlogging

Documentation

Overview

Package tf5serverlogging contains logging functionality specific to tf5server and tfprotov5 types.

Index

• func DownstreamRequest(ctx context.Context) context.Context
• func DownstreamResponse(ctx context.Context, diagnostics diag.Diagnostics)
• func DownstreamResponseWithError(ctx context.Context, funcErr *tfprotov6.FunctionError)
• func ServerCapabilities(ctx context.Context, capabilities *tfprotov6.ServerCapabilities)
• type ContextKeyDownstreamRequestStartTime

Functions

func DownstreamRequest

func DownstreamRequest(ctx context.Context) context.Context

DownstreamRequest sets a request duration start time context key and generates a TRACE "Sending request downstream" log.

func DownstreamResponse

func DownstreamResponse(ctx context.Context, diagnostics diag.Diagnostics)

DownstreamResponse generates the following logging:

• TRACE "Received downstream response" log with request duration and diagnostic severity counts
• Per-diagnostic logs

func DownstreamResponseWithError

func DownstreamResponseWithError(ctx context.Context, funcErr *tfprotov6.FunctionError)

DownstreamResponseWithError generates the following logging:

• TRACE "Received downstream response" log with request duration and whether a function error is present
• Log with function error details

func ServerCapabilities

func ServerCapabilities(ctx context.Context, capabilities *tfprotov6.ServerCapabilities)

ServerCapabilities generates a TRACE "Announced server capabilities" log.

Types

type ContextKeyDownstreamRequestStartTime

type ContextKeyDownstreamRequestStartTime struct{}

ContextKeyDownstreamRequestStartTime is a context.Context key to store the time.Time when the server began a downstream request.