tf5serverlogging

Documentation

Overview

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

Index

• func ConfigureProviderClientCapabilities(ctx context.Context, ...)
• func Deferred(ctx context.Context, deferred *tfprotov5.Deferred)
• func DownstreamRequest(ctx context.Context) context.Context
• func DownstreamResponse(ctx context.Context, diagnostics diag.Diagnostics)
• func DownstreamResponseWithError(ctx context.Context, funcErr *tfprotov5.FunctionError)
• func ImportResourceStateClientCapabilities(ctx context.Context, ...)
• func OpenEphemeralResourceClientCapabilities(ctx context.Context, ...)
• func PlanResourceChangeClientCapabilities(ctx context.Context, ...)
• func ReadDataSourceClientCapabilities(ctx context.Context, capabilities *tfprotov5.ReadDataSourceClientCapabilities)
• func ReadResourceClientCapabilities(ctx context.Context, capabilities *tfprotov5.ReadResourceClientCapabilities)
• func ServerCapabilities(ctx context.Context, capabilities *tfprotov5.ServerCapabilities)
• type ContextKeyDownstreamRequestStartTime

Functions

func ConfigureProviderClientCapabilities

func ConfigureProviderClientCapabilities(ctx context.Context, capabilities *tfprotov5.ConfigureProviderClientCapabilities)

ConfigureProviderClientCapabilities generates a TRACE "Announced client capabilities" log.

func Deferred

func Deferred(ctx context.Context, deferred *tfprotov5.Deferred)

Deferred generates a TRACE "Received downstream deferred response" log if populated.

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 *tfprotov5.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 ImportResourceStateClientCapabilities

func ImportResourceStateClientCapabilities(ctx context.Context, capabilities *tfprotov5.ImportResourceStateClientCapabilities)

ImportResourceStateClientCapabilities generates a TRACE "Announced client capabilities" log.

func OpenEphemeralResourceClientCapabilities

func OpenEphemeralResourceClientCapabilities(ctx context.Context, capabilities *tfprotov5.OpenEphemeralResourceClientCapabilities)

OpenEphemeralResourceClientCapabilities generates a TRACE "Announced client capabilities" log.

func PlanResourceChangeClientCapabilities

func PlanResourceChangeClientCapabilities(ctx context.Context, capabilities *tfprotov5.PlanResourceChangeClientCapabilities)

PlanResourceChangeClientCapabilities generates a TRACE "Announced client capabilities" log.

func ReadDataSourceClientCapabilities

func ReadDataSourceClientCapabilities(ctx context.Context, capabilities *tfprotov5.ReadDataSourceClientCapabilities)

ReadDataSourceClientCapabilities generates a TRACE "Announced client capabilities" log.

func ReadResourceClientCapabilities

func ReadResourceClientCapabilities(ctx context.Context, capabilities *tfprotov5.ReadResourceClientCapabilities)

ReadResourceClientCapabilities generates a TRACE "Announced client capabilities" log.

func ServerCapabilities

func ServerCapabilities(ctx context.Context, capabilities *tfprotov5.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.