// Code generated from semantic convention specification. DO NOT EDIT. // Copyright The OpenTelemetry Authors // SPDX-License-Identifier: Apache-2.0 // Package rpcconv provides types and functionality for OpenTelemetry semantic // conventions in the "rpc" namespace. package rpcconv import ( "context" "sync" "go.opentelemetry.io/otel/attribute" "go.opentelemetry.io/otel/metric" "go.opentelemetry.io/otel/metric/noop" ) var ( addOptPool = &sync.Pool{New: func() any { return &[]metric.AddOption{} }} recOptPool = &sync.Pool{New: func() any { return &[]metric.RecordOption{} }} ) // ErrorTypeAttr is an attribute conforming to the error.type semantic // conventions. It represents the describes a class of error the operation ended // with. type ErrorTypeAttr string var ( // ErrorTypeOther is a fallback error value to be used when the instrumentation // doesn't define a custom value. ErrorTypeOther ErrorTypeAttr = "_OTHER" ) // NetworkTransportAttr is an attribute conforming to the network.transport // semantic conventions. It represents the [OSI transport layer] or // [inter-process communication method]. // // [OSI transport layer]: https://wikipedia.org/wiki/Transport_layer // [inter-process communication method]: https://wikipedia.org/wiki/Inter-process_communication type NetworkTransportAttr string var ( // NetworkTransportTCP is the TCP. NetworkTransportTCP NetworkTransportAttr = "tcp" // NetworkTransportUDP is the UDP. NetworkTransportUDP NetworkTransportAttr = "udp" // NetworkTransportPipe is the named or anonymous pipe. NetworkTransportPipe NetworkTransportAttr = "pipe" // NetworkTransportUnix is the unix domain socket. NetworkTransportUnix NetworkTransportAttr = "unix" // NetworkTransportQUIC is the QUIC. NetworkTransportQUIC NetworkTransportAttr = "quic" ) // SystemNameAttr is an attribute conforming to the rpc.system.name semantic // conventions. It represents the Remote Procedure Call (RPC) system. type SystemNameAttr string var ( // SystemNameGRPC is the [gRPC]. // // [gRPC]: https://grpc.io/ SystemNameGRPC SystemNameAttr = "grpc" // SystemNameDubbo is the [Apache Dubbo]. // // [Apache Dubbo]: https://dubbo.apache.org/ SystemNameDubbo SystemNameAttr = "dubbo" // SystemNameConnectrpc is the [Connect RPC]. // // [Connect RPC]: https://connectrpc.com/ SystemNameConnectrpc SystemNameAttr = "connectrpc" // SystemNameJSONRPC is the [JSON-RPC]. // // [JSON-RPC]: https://www.jsonrpc.org/ SystemNameJSONRPC SystemNameAttr = "jsonrpc" ) // ClientCallDuration is an instrument used to record metric values conforming to // the "rpc.client.call.duration" semantic conventions. It represents the // measures the duration of outbound remote procedure calls (RPC). type ClientCallDuration struct { metric.Float64Histogram } var newClientCallDurationOpts = []metric.Float64HistogramOption{ metric.WithDescription("Measures the duration of outbound remote procedure calls (RPC)."), metric.WithUnit("s"), } // NewClientCallDuration returns a new ClientCallDuration instrument. func NewClientCallDuration( m metric.Meter, opt ...metric.Float64HistogramOption, ) (ClientCallDuration, error) { // Check if the meter is nil. if m == nil { return ClientCallDuration{noop.Float64Histogram{}}, nil } if len(opt) == 0 { opt = newClientCallDurationOpts } else { opt = append(opt, newClientCallDurationOpts...) } i, err := m.Float64Histogram( "rpc.client.call.duration", opt..., ) if err != nil { return ClientCallDuration{noop.Float64Histogram{}}, err } return ClientCallDuration{i}, nil } // Inst returns the underlying metric instrument. func (m ClientCallDuration) Inst() metric.Float64Histogram { return m.Float64Histogram } // Name returns the semantic convention name of the instrument. func (ClientCallDuration) Name() string { return "rpc.client.call.duration" } // Unit returns the semantic convention unit of the instrument func (ClientCallDuration) Unit() string { return "s" } // Description returns the semantic convention description of the instrument func (ClientCallDuration) Description() string { return "Measures the duration of outbound remote procedure calls (RPC)." } // Record records val to the current distribution for attrs. // // The systemName is the the Remote Procedure Call (RPC) system. // // All additional attrs passed are included in the recorded value. // // When this metric is reported alongside an RPC client span, the metric value // SHOULD be the same as the RPC client span duration. func (m ClientCallDuration) Record( ctx context.Context, val float64, systemName SystemNameAttr, attrs ...attribute.KeyValue, ) { if len(attrs) == 0 { m.Float64Histogram.Record(ctx, val, metric.WithAttributes( attribute.String("rpc.system.name", string(systemName)), )) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append( *o, metric.WithAttributes( append( attrs, attribute.String("rpc.system.name", string(systemName)), )..., ), ) m.Float64Histogram.Record(ctx, val, *o...) } // RecordSet records val to the current distribution for set. // // When this metric is reported alongside an RPC client span, the metric value // SHOULD be the same as the RPC client span duration. func (m ClientCallDuration) RecordSet(ctx context.Context, val float64, set attribute.Set) { if set.Len() == 0 { m.Float64Histogram.Record(ctx, val) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append(*o, metric.WithAttributeSet(set)) m.Float64Histogram.Record(ctx, val, *o...) } // AttrErrorType returns an optional attribute for the "error.type" semantic // convention. It represents the describes a class of error the operation ended // with. func (ClientCallDuration) AttrErrorType(val ErrorTypeAttr) attribute.KeyValue { return attribute.String("error.type", string(val)) } // AttrMethod returns an optional attribute for the "rpc.method" semantic // convention. It represents the fully-qualified logical name of the method from // the RPC interface perspective. func (ClientCallDuration) AttrMethod(val string) attribute.KeyValue { return attribute.String("rpc.method", val) } // AttrResponseStatusCode returns an optional attribute for the // "rpc.response.status_code" semantic convention. It represents the status code // of the RPC returned by the RPC server or generated by the client. func (ClientCallDuration) AttrResponseStatusCode(val string) attribute.KeyValue { return attribute.String("rpc.response.status_code", val) } // AttrServerAddress returns an optional attribute for the "server.address" // semantic convention. It represents the RPC server [host name]. // // [host name]: https://grpc.github.io/grpc/core/md_doc_naming.html func (ClientCallDuration) AttrServerAddress(val string) attribute.KeyValue { return attribute.String("server.address", val) } // AttrServerPort returns an optional attribute for the "server.port" semantic // convention. It represents the server port number. func (ClientCallDuration) AttrServerPort(val int) attribute.KeyValue { return attribute.Int("server.port", val) } // AttrNetworkProtocolName returns an optional attribute for the // "network.protocol.name" semantic convention. It represents the // [OSI application layer] or non-OSI equivalent. // // [OSI application layer]: https://wikipedia.org/wiki/Application_layer func (ClientCallDuration) AttrNetworkProtocolName(val string) attribute.KeyValue { return attribute.String("network.protocol.name", val) } // AttrNetworkProtocolVersion returns an optional attribute for the // "network.protocol.version" semantic convention. It represents the actual // version of the protocol used for network communication. func (ClientCallDuration) AttrNetworkProtocolVersion(val string) attribute.KeyValue { return attribute.String("network.protocol.version", val) } // AttrNetworkTransport returns an optional attribute for the "network.transport" // semantic convention. It represents the [OSI transport layer] or // [inter-process communication method]. // // [OSI transport layer]: https://wikipedia.org/wiki/Transport_layer // [inter-process communication method]: https://wikipedia.org/wiki/Inter-process_communication func (ClientCallDuration) AttrNetworkTransport(val NetworkTransportAttr) attribute.KeyValue { return attribute.String("network.transport", string(val)) } // ClientRequestSize is an instrument used to record metric values conforming to // the "rpc.client.request.size" semantic conventions. It represents the measures // the size of RPC request messages (uncompressed). type ClientRequestSize struct { metric.Int64Histogram } var newClientRequestSizeOpts = []metric.Int64HistogramOption{ metric.WithDescription("Measures the size of RPC request messages (uncompressed)."), metric.WithUnit("By"), } // NewClientRequestSize returns a new ClientRequestSize instrument. func NewClientRequestSize( m metric.Meter, opt ...metric.Int64HistogramOption, ) (ClientRequestSize, error) { // Check if the meter is nil. if m == nil { return ClientRequestSize{noop.Int64Histogram{}}, nil } if len(opt) == 0 { opt = newClientRequestSizeOpts } else { opt = append(opt, newClientRequestSizeOpts...) } i, err := m.Int64Histogram( "rpc.client.request.size", opt..., ) if err != nil { return ClientRequestSize{noop.Int64Histogram{}}, err } return ClientRequestSize{i}, nil } // Inst returns the underlying metric instrument. func (m ClientRequestSize) Inst() metric.Int64Histogram { return m.Int64Histogram } // Name returns the semantic convention name of the instrument. func (ClientRequestSize) Name() string { return "rpc.client.request.size" } // Unit returns the semantic convention unit of the instrument func (ClientRequestSize) Unit() string { return "By" } // Description returns the semantic convention description of the instrument func (ClientRequestSize) Description() string { return "Measures the size of RPC request messages (uncompressed)." } // Record records val to the current distribution for attrs. // // The systemName is the the Remote Procedure Call (RPC) system. // // All additional attrs passed are included in the recorded value. // // **Streaming**: Recorded per message in a streaming batch func (m ClientRequestSize) Record( ctx context.Context, val int64, systemName SystemNameAttr, attrs ...attribute.KeyValue, ) { if len(attrs) == 0 { m.Int64Histogram.Record(ctx, val, metric.WithAttributes( attribute.String("rpc.system.name", string(systemName)), )) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append( *o, metric.WithAttributes( append( attrs, attribute.String("rpc.system.name", string(systemName)), )..., ), ) m.Int64Histogram.Record(ctx, val, *o...) } // RecordSet records val to the current distribution for set. // // **Streaming**: Recorded per message in a streaming batch func (m ClientRequestSize) RecordSet(ctx context.Context, val int64, set attribute.Set) { if set.Len() == 0 { m.Int64Histogram.Record(ctx, val) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append(*o, metric.WithAttributeSet(set)) m.Int64Histogram.Record(ctx, val, *o...) } // AttrErrorType returns an optional attribute for the "error.type" semantic // convention. It represents the describes a class of error the operation ended // with. func (ClientRequestSize) AttrErrorType(val ErrorTypeAttr) attribute.KeyValue { return attribute.String("error.type", string(val)) } // AttrMethod returns an optional attribute for the "rpc.method" semantic // convention. It represents the fully-qualified logical name of the method from // the RPC interface perspective. func (ClientRequestSize) AttrMethod(val string) attribute.KeyValue { return attribute.String("rpc.method", val) } // AttrResponseStatusCode returns an optional attribute for the // "rpc.response.status_code" semantic convention. It represents the status code // of the RPC returned by the RPC server or generated by the client. func (ClientRequestSize) AttrResponseStatusCode(val string) attribute.KeyValue { return attribute.String("rpc.response.status_code", val) } // AttrServerAddress returns an optional attribute for the "server.address" // semantic convention. It represents the RPC server [host name]. // // [host name]: https://grpc.github.io/grpc/core/md_doc_naming.html func (ClientRequestSize) AttrServerAddress(val string) attribute.KeyValue { return attribute.String("server.address", val) } // AttrServerPort returns an optional attribute for the "server.port" semantic // convention. It represents the server port number. func (ClientRequestSize) AttrServerPort(val int) attribute.KeyValue { return attribute.Int("server.port", val) } // AttrNetworkProtocolName returns an optional attribute for the // "network.protocol.name" semantic convention. It represents the // [OSI application layer] or non-OSI equivalent. // // [OSI application layer]: https://wikipedia.org/wiki/Application_layer func (ClientRequestSize) AttrNetworkProtocolName(val string) attribute.KeyValue { return attribute.String("network.protocol.name", val) } // AttrNetworkProtocolVersion returns an optional attribute for the // "network.protocol.version" semantic convention. It represents the actual // version of the protocol used for network communication. func (ClientRequestSize) AttrNetworkProtocolVersion(val string) attribute.KeyValue { return attribute.String("network.protocol.version", val) } // AttrNetworkTransport returns an optional attribute for the "network.transport" // semantic convention. It represents the [OSI transport layer] or // [inter-process communication method]. // // [OSI transport layer]: https://wikipedia.org/wiki/Transport_layer // [inter-process communication method]: https://wikipedia.org/wiki/Inter-process_communication func (ClientRequestSize) AttrNetworkTransport(val NetworkTransportAttr) attribute.KeyValue { return attribute.String("network.transport", string(val)) } // ClientResponseSize is an instrument used to record metric values conforming to // the "rpc.client.response.size" semantic conventions. It represents the // measures the size of RPC response messages (uncompressed). type ClientResponseSize struct { metric.Int64Histogram } var newClientResponseSizeOpts = []metric.Int64HistogramOption{ metric.WithDescription("Measures the size of RPC response messages (uncompressed)."), metric.WithUnit("By"), } // NewClientResponseSize returns a new ClientResponseSize instrument. func NewClientResponseSize( m metric.Meter, opt ...metric.Int64HistogramOption, ) (ClientResponseSize, error) { // Check if the meter is nil. if m == nil { return ClientResponseSize{noop.Int64Histogram{}}, nil } if len(opt) == 0 { opt = newClientResponseSizeOpts } else { opt = append(opt, newClientResponseSizeOpts...) } i, err := m.Int64Histogram( "rpc.client.response.size", opt..., ) if err != nil { return ClientResponseSize{noop.Int64Histogram{}}, err } return ClientResponseSize{i}, nil } // Inst returns the underlying metric instrument. func (m ClientResponseSize) Inst() metric.Int64Histogram { return m.Int64Histogram } // Name returns the semantic convention name of the instrument. func (ClientResponseSize) Name() string { return "rpc.client.response.size" } // Unit returns the semantic convention unit of the instrument func (ClientResponseSize) Unit() string { return "By" } // Description returns the semantic convention description of the instrument func (ClientResponseSize) Description() string { return "Measures the size of RPC response messages (uncompressed)." } // Record records val to the current distribution for attrs. // // The systemName is the the Remote Procedure Call (RPC) system. // // All additional attrs passed are included in the recorded value. // // **Streaming**: Recorded per response in a streaming batch func (m ClientResponseSize) Record( ctx context.Context, val int64, systemName SystemNameAttr, attrs ...attribute.KeyValue, ) { if len(attrs) == 0 { m.Int64Histogram.Record(ctx, val, metric.WithAttributes( attribute.String("rpc.system.name", string(systemName)), )) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append( *o, metric.WithAttributes( append( attrs, attribute.String("rpc.system.name", string(systemName)), )..., ), ) m.Int64Histogram.Record(ctx, val, *o...) } // RecordSet records val to the current distribution for set. // // **Streaming**: Recorded per response in a streaming batch func (m ClientResponseSize) RecordSet(ctx context.Context, val int64, set attribute.Set) { if set.Len() == 0 { m.Int64Histogram.Record(ctx, val) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append(*o, metric.WithAttributeSet(set)) m.Int64Histogram.Record(ctx, val, *o...) } // AttrErrorType returns an optional attribute for the "error.type" semantic // convention. It represents the describes a class of error the operation ended // with. func (ClientResponseSize) AttrErrorType(val ErrorTypeAttr) attribute.KeyValue { return attribute.String("error.type", string(val)) } // AttrMethod returns an optional attribute for the "rpc.method" semantic // convention. It represents the fully-qualified logical name of the method from // the RPC interface perspective. func (ClientResponseSize) AttrMethod(val string) attribute.KeyValue { return attribute.String("rpc.method", val) } // AttrResponseStatusCode returns an optional attribute for the // "rpc.response.status_code" semantic convention. It represents the status code // of the RPC returned by the RPC server or generated by the client. func (ClientResponseSize) AttrResponseStatusCode(val string) attribute.KeyValue { return attribute.String("rpc.response.status_code", val) } // AttrServerAddress returns an optional attribute for the "server.address" // semantic convention. It represents the RPC server [host name]. // // [host name]: https://grpc.github.io/grpc/core/md_doc_naming.html func (ClientResponseSize) AttrServerAddress(val string) attribute.KeyValue { return attribute.String("server.address", val) } // AttrServerPort returns an optional attribute for the "server.port" semantic // convention. It represents the server port number. func (ClientResponseSize) AttrServerPort(val int) attribute.KeyValue { return attribute.Int("server.port", val) } // AttrNetworkProtocolName returns an optional attribute for the // "network.protocol.name" semantic convention. It represents the // [OSI application layer] or non-OSI equivalent. // // [OSI application layer]: https://wikipedia.org/wiki/Application_layer func (ClientResponseSize) AttrNetworkProtocolName(val string) attribute.KeyValue { return attribute.String("network.protocol.name", val) } // AttrNetworkProtocolVersion returns an optional attribute for the // "network.protocol.version" semantic convention. It represents the actual // version of the protocol used for network communication. func (ClientResponseSize) AttrNetworkProtocolVersion(val string) attribute.KeyValue { return attribute.String("network.protocol.version", val) } // AttrNetworkTransport returns an optional attribute for the "network.transport" // semantic convention. It represents the [OSI transport layer] or // [inter-process communication method]. // // [OSI transport layer]: https://wikipedia.org/wiki/Transport_layer // [inter-process communication method]: https://wikipedia.org/wiki/Inter-process_communication func (ClientResponseSize) AttrNetworkTransport(val NetworkTransportAttr) attribute.KeyValue { return attribute.String("network.transport", string(val)) } // ServerCallDuration is an instrument used to record metric values conforming to // the "rpc.server.call.duration" semantic conventions. It represents the // measures the duration of inbound remote procedure calls (RPC). type ServerCallDuration struct { metric.Float64Histogram } var newServerCallDurationOpts = []metric.Float64HistogramOption{ metric.WithDescription("Measures the duration of inbound remote procedure calls (RPC)."), metric.WithUnit("s"), } // NewServerCallDuration returns a new ServerCallDuration instrument. func NewServerCallDuration( m metric.Meter, opt ...metric.Float64HistogramOption, ) (ServerCallDuration, error) { // Check if the meter is nil. if m == nil { return ServerCallDuration{noop.Float64Histogram{}}, nil } if len(opt) == 0 { opt = newServerCallDurationOpts } else { opt = append(opt, newServerCallDurationOpts...) } i, err := m.Float64Histogram( "rpc.server.call.duration", opt..., ) if err != nil { return ServerCallDuration{noop.Float64Histogram{}}, err } return ServerCallDuration{i}, nil } // Inst returns the underlying metric instrument. func (m ServerCallDuration) Inst() metric.Float64Histogram { return m.Float64Histogram } // Name returns the semantic convention name of the instrument. func (ServerCallDuration) Name() string { return "rpc.server.call.duration" } // Unit returns the semantic convention unit of the instrument func (ServerCallDuration) Unit() string { return "s" } // Description returns the semantic convention description of the instrument func (ServerCallDuration) Description() string { return "Measures the duration of inbound remote procedure calls (RPC)." } // Record records val to the current distribution for attrs. // // The systemName is the the Remote Procedure Call (RPC) system. // // All additional attrs passed are included in the recorded value. // // When this metric is reported alongside an RPC server span, the metric value // SHOULD be the same as the RPC server span duration. func (m ServerCallDuration) Record( ctx context.Context, val float64, systemName SystemNameAttr, attrs ...attribute.KeyValue, ) { if len(attrs) == 0 { m.Float64Histogram.Record(ctx, val, metric.WithAttributes( attribute.String("rpc.system.name", string(systemName)), )) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append( *o, metric.WithAttributes( append( attrs, attribute.String("rpc.system.name", string(systemName)), )..., ), ) m.Float64Histogram.Record(ctx, val, *o...) } // RecordSet records val to the current distribution for set. // // When this metric is reported alongside an RPC server span, the metric value // SHOULD be the same as the RPC server span duration. func (m ServerCallDuration) RecordSet(ctx context.Context, val float64, set attribute.Set) { if set.Len() == 0 { m.Float64Histogram.Record(ctx, val) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append(*o, metric.WithAttributeSet(set)) m.Float64Histogram.Record(ctx, val, *o...) } // AttrErrorType returns an optional attribute for the "error.type" semantic // convention. It represents the describes a class of error the operation ended // with. func (ServerCallDuration) AttrErrorType(val ErrorTypeAttr) attribute.KeyValue { return attribute.String("error.type", string(val)) } // AttrMethod returns an optional attribute for the "rpc.method" semantic // convention. It represents the fully-qualified logical name of the method from // the RPC interface perspective. func (ServerCallDuration) AttrMethod(val string) attribute.KeyValue { return attribute.String("rpc.method", val) } // AttrResponseStatusCode returns an optional attribute for the // "rpc.response.status_code" semantic convention. It represents the status code // of the RPC returned by the RPC server or generated by the client. func (ServerCallDuration) AttrResponseStatusCode(val string) attribute.KeyValue { return attribute.String("rpc.response.status_code", val) } // AttrNetworkProtocolName returns an optional attribute for the // "network.protocol.name" semantic convention. It represents the // [OSI application layer] or non-OSI equivalent. // // [OSI application layer]: https://wikipedia.org/wiki/Application_layer func (ServerCallDuration) AttrNetworkProtocolName(val string) attribute.KeyValue { return attribute.String("network.protocol.name", val) } // AttrNetworkProtocolVersion returns an optional attribute for the // "network.protocol.version" semantic convention. It represents the actual // version of the protocol used for network communication. func (ServerCallDuration) AttrNetworkProtocolVersion(val string) attribute.KeyValue { return attribute.String("network.protocol.version", val) } // AttrNetworkTransport returns an optional attribute for the "network.transport" // semantic convention. It represents the [OSI transport layer] or // [inter-process communication method]. // // [OSI transport layer]: https://wikipedia.org/wiki/Transport_layer // [inter-process communication method]: https://wikipedia.org/wiki/Inter-process_communication func (ServerCallDuration) AttrNetworkTransport(val NetworkTransportAttr) attribute.KeyValue { return attribute.String("network.transport", string(val)) } // AttrServerAddress returns an optional attribute for the "server.address" // semantic convention. It represents the RPC server [host name]. // // [host name]: https://grpc.github.io/grpc/core/md_doc_naming.html func (ServerCallDuration) AttrServerAddress(val string) attribute.KeyValue { return attribute.String("server.address", val) } // AttrServerPort returns an optional attribute for the "server.port" semantic // convention. It represents the server port number. func (ServerCallDuration) AttrServerPort(val int) attribute.KeyValue { return attribute.Int("server.port", val) } // ServerRequestSize is an instrument used to record metric values conforming to // the "rpc.server.request.size" semantic conventions. It represents the measures // the size of RPC request messages (uncompressed). type ServerRequestSize struct { metric.Int64Histogram } var newServerRequestSizeOpts = []metric.Int64HistogramOption{ metric.WithDescription("Measures the size of RPC request messages (uncompressed)."), metric.WithUnit("By"), } // NewServerRequestSize returns a new ServerRequestSize instrument. func NewServerRequestSize( m metric.Meter, opt ...metric.Int64HistogramOption, ) (ServerRequestSize, error) { // Check if the meter is nil. if m == nil { return ServerRequestSize{noop.Int64Histogram{}}, nil } if len(opt) == 0 { opt = newServerRequestSizeOpts } else { opt = append(opt, newServerRequestSizeOpts...) } i, err := m.Int64Histogram( "rpc.server.request.size", opt..., ) if err != nil { return ServerRequestSize{noop.Int64Histogram{}}, err } return ServerRequestSize{i}, nil } // Inst returns the underlying metric instrument. func (m ServerRequestSize) Inst() metric.Int64Histogram { return m.Int64Histogram } // Name returns the semantic convention name of the instrument. func (ServerRequestSize) Name() string { return "rpc.server.request.size" } // Unit returns the semantic convention unit of the instrument func (ServerRequestSize) Unit() string { return "By" } // Description returns the semantic convention description of the instrument func (ServerRequestSize) Description() string { return "Measures the size of RPC request messages (uncompressed)." } // Record records val to the current distribution for attrs. // // The systemName is the the Remote Procedure Call (RPC) system. // // All additional attrs passed are included in the recorded value. // // **Streaming**: Recorded per message in a streaming batch func (m ServerRequestSize) Record( ctx context.Context, val int64, systemName SystemNameAttr, attrs ...attribute.KeyValue, ) { if len(attrs) == 0 { m.Int64Histogram.Record(ctx, val, metric.WithAttributes( attribute.String("rpc.system.name", string(systemName)), )) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append( *o, metric.WithAttributes( append( attrs, attribute.String("rpc.system.name", string(systemName)), )..., ), ) m.Int64Histogram.Record(ctx, val, *o...) } // RecordSet records val to the current distribution for set. // // **Streaming**: Recorded per message in a streaming batch func (m ServerRequestSize) RecordSet(ctx context.Context, val int64, set attribute.Set) { if set.Len() == 0 { m.Int64Histogram.Record(ctx, val) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append(*o, metric.WithAttributeSet(set)) m.Int64Histogram.Record(ctx, val, *o...) } // AttrErrorType returns an optional attribute for the "error.type" semantic // convention. It represents the describes a class of error the operation ended // with. func (ServerRequestSize) AttrErrorType(val ErrorTypeAttr) attribute.KeyValue { return attribute.String("error.type", string(val)) } // AttrMethod returns an optional attribute for the "rpc.method" semantic // convention. It represents the fully-qualified logical name of the method from // the RPC interface perspective. func (ServerRequestSize) AttrMethod(val string) attribute.KeyValue { return attribute.String("rpc.method", val) } // AttrResponseStatusCode returns an optional attribute for the // "rpc.response.status_code" semantic convention. It represents the status code // of the RPC returned by the RPC server or generated by the client. func (ServerRequestSize) AttrResponseStatusCode(val string) attribute.KeyValue { return attribute.String("rpc.response.status_code", val) } // AttrNetworkProtocolName returns an optional attribute for the // "network.protocol.name" semantic convention. It represents the // [OSI application layer] or non-OSI equivalent. // // [OSI application layer]: https://wikipedia.org/wiki/Application_layer func (ServerRequestSize) AttrNetworkProtocolName(val string) attribute.KeyValue { return attribute.String("network.protocol.name", val) } // AttrNetworkProtocolVersion returns an optional attribute for the // "network.protocol.version" semantic convention. It represents the actual // version of the protocol used for network communication. func (ServerRequestSize) AttrNetworkProtocolVersion(val string) attribute.KeyValue { return attribute.String("network.protocol.version", val) } // AttrNetworkTransport returns an optional attribute for the "network.transport" // semantic convention. It represents the [OSI transport layer] or // [inter-process communication method]. // // [OSI transport layer]: https://wikipedia.org/wiki/Transport_layer // [inter-process communication method]: https://wikipedia.org/wiki/Inter-process_communication func (ServerRequestSize) AttrNetworkTransport(val NetworkTransportAttr) attribute.KeyValue { return attribute.String("network.transport", string(val)) } // AttrServerAddress returns an optional attribute for the "server.address" // semantic convention. It represents the RPC server [host name]. // // [host name]: https://grpc.github.io/grpc/core/md_doc_naming.html func (ServerRequestSize) AttrServerAddress(val string) attribute.KeyValue { return attribute.String("server.address", val) } // AttrServerPort returns an optional attribute for the "server.port" semantic // convention. It represents the server port number. func (ServerRequestSize) AttrServerPort(val int) attribute.KeyValue { return attribute.Int("server.port", val) } // ServerResponseSize is an instrument used to record metric values conforming to // the "rpc.server.response.size" semantic conventions. It represents the // measures the size of RPC response messages (uncompressed). type ServerResponseSize struct { metric.Int64Histogram } var newServerResponseSizeOpts = []metric.Int64HistogramOption{ metric.WithDescription("Measures the size of RPC response messages (uncompressed)."), metric.WithUnit("By"), } // NewServerResponseSize returns a new ServerResponseSize instrument. func NewServerResponseSize( m metric.Meter, opt ...metric.Int64HistogramOption, ) (ServerResponseSize, error) { // Check if the meter is nil. if m == nil { return ServerResponseSize{noop.Int64Histogram{}}, nil } if len(opt) == 0 { opt = newServerResponseSizeOpts } else { opt = append(opt, newServerResponseSizeOpts...) } i, err := m.Int64Histogram( "rpc.server.response.size", opt..., ) if err != nil { return ServerResponseSize{noop.Int64Histogram{}}, err } return ServerResponseSize{i}, nil } // Inst returns the underlying metric instrument. func (m ServerResponseSize) Inst() metric.Int64Histogram { return m.Int64Histogram } // Name returns the semantic convention name of the instrument. func (ServerResponseSize) Name() string { return "rpc.server.response.size" } // Unit returns the semantic convention unit of the instrument func (ServerResponseSize) Unit() string { return "By" } // Description returns the semantic convention description of the instrument func (ServerResponseSize) Description() string { return "Measures the size of RPC response messages (uncompressed)." } // Record records val to the current distribution for attrs. // // The systemName is the the Remote Procedure Call (RPC) system. // // All additional attrs passed are included in the recorded value. // // **Streaming**: Recorded per response in a streaming batch func (m ServerResponseSize) Record( ctx context.Context, val int64, systemName SystemNameAttr, attrs ...attribute.KeyValue, ) { if len(attrs) == 0 { m.Int64Histogram.Record(ctx, val, metric.WithAttributes( attribute.String("rpc.system.name", string(systemName)), )) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append( *o, metric.WithAttributes( append( attrs, attribute.String("rpc.system.name", string(systemName)), )..., ), ) m.Int64Histogram.Record(ctx, val, *o...) } // RecordSet records val to the current distribution for set. // // **Streaming**: Recorded per response in a streaming batch func (m ServerResponseSize) RecordSet(ctx context.Context, val int64, set attribute.Set) { if set.Len() == 0 { m.Int64Histogram.Record(ctx, val) return } o := recOptPool.Get().(*[]metric.RecordOption) defer func() { *o = (*o)[:0] recOptPool.Put(o) }() *o = append(*o, metric.WithAttributeSet(set)) m.Int64Histogram.Record(ctx, val, *o...) } // AttrErrorType returns an optional attribute for the "error.type" semantic // convention. It represents the describes a class of error the operation ended // with. func (ServerResponseSize) AttrErrorType(val ErrorTypeAttr) attribute.KeyValue { return attribute.String("error.type", string(val)) } // AttrMethod returns an optional attribute for the "rpc.method" semantic // convention. It represents the fully-qualified logical name of the method from // the RPC interface perspective. func (ServerResponseSize) AttrMethod(val string) attribute.KeyValue { return attribute.String("rpc.method", val) } // AttrResponseStatusCode returns an optional attribute for the // "rpc.response.status_code" semantic convention. It represents the status code // of the RPC returned by the RPC server or generated by the client. func (ServerResponseSize) AttrResponseStatusCode(val string) attribute.KeyValue { return attribute.String("rpc.response.status_code", val) } // AttrNetworkProtocolName returns an optional attribute for the // "network.protocol.name" semantic convention. It represents the // [OSI application layer] or non-OSI equivalent. // // [OSI application layer]: https://wikipedia.org/wiki/Application_layer func (ServerResponseSize) AttrNetworkProtocolName(val string) attribute.KeyValue { return attribute.String("network.protocol.name", val) } // AttrNetworkProtocolVersion returns an optional attribute for the // "network.protocol.version" semantic convention. It represents the actual // version of the protocol used for network communication. func (ServerResponseSize) AttrNetworkProtocolVersion(val string) attribute.KeyValue { return attribute.String("network.protocol.version", val) } // AttrNetworkTransport returns an optional attribute for the "network.transport" // semantic convention. It represents the [OSI transport layer] or // [inter-process communication method]. // // [OSI transport layer]: https://wikipedia.org/wiki/Transport_layer // [inter-process communication method]: https://wikipedia.org/wiki/Inter-process_communication func (ServerResponseSize) AttrNetworkTransport(val NetworkTransportAttr) attribute.KeyValue { return attribute.String("network.transport", string(val)) } // AttrServerAddress returns an optional attribute for the "server.address" // semantic convention. It represents the RPC server [host name]. // // [host name]: https://grpc.github.io/grpc/core/md_doc_naming.html func (ServerResponseSize) AttrServerAddress(val string) attribute.KeyValue { return attribute.String("server.address", val) } // AttrServerPort returns an optional attribute for the "server.port" semantic // convention. It represents the server port number. func (ServerResponseSize) AttrServerPort(val int) attribute.KeyValue { return attribute.Int("server.port", val) }