OpenTelemetry PHP

InstrumentationLibraryMetrics extends Message
in package

A collection of Metrics produced by an InstrumentationLibrary.

InstrumentationLibraryMetrics is wire-compatible with ScopeMetrics for binary Protobuf format. This message is deprecated and will be removed on June 15, 2022.

Generated from protobuf message opentelemetry.proto.metrics.v1.InstrumentationLibraryMetrics

Table of Contents

Properties

$instrumentation_library  : mixed
The instrumentation library information for the metrics in this message.
$schema_url  : mixed
This schema_url applies to all metrics in the "metrics" field.
$metrics  : mixed
A list of metrics that originate from an instrumentation library.

Methods

__construct()  : mixed
Constructor.
clearInstrumentationLibrary()  : mixed
getInstrumentationLibrary()  : InstrumentationLibrary|null
The instrumentation library information for the metrics in this message.
getMetrics()  : RepeatedField
A list of metrics that originate from an instrumentation library.
getSchemaUrl()  : string
This schema_url applies to all metrics in the "metrics" field.
hasInstrumentationLibrary()  : mixed
setInstrumentationLibrary()  : $this
The instrumentation library information for the metrics in this message.
setMetrics()  : $this
A list of metrics that originate from an instrumentation library.
setSchemaUrl()  : $this
This schema_url applies to all metrics in the "metrics" field.

Properties

$instrumentation_library

The instrumentation library information for the metrics in this message.

protected mixed $instrumentation_library = null

Semantically when InstrumentationLibrary isn't set, it is equivalent with an empty instrumentation library name (unknown).

Generated from protobuf field .opentelemetry.proto.common.v1.InstrumentationLibrary instrumentation_library = 1;

$schema_url

This schema_url applies to all metrics in the "metrics" field.

protected mixed $schema_url = ''

Generated from protobuf field string schema_url = 3;

$metrics

A list of metrics that originate from an instrumentation library.

private mixed $metrics

Generated from protobuf field repeated .opentelemetry.proto.metrics.v1.Metric metrics = 2;

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type \Opentelemetry\Proto\Common\V1\InstrumentationLibrary $instrumentation_library
      The instrumentation library information for the metrics in this message.
      Semantically when InstrumentationLibrary isn't set, it is equivalent with
      an empty instrumentation library name (unknown).
@type \Opentelemetry\Proto\Metrics\V1\Metric[]|\Google\Protobuf\Internal\RepeatedField $metrics
      A list of metrics that originate from an instrumentation library.
@type string $schema_url
      This schema_url applies to all metrics in the "metrics" field.

}

getInstrumentationLibrary()

The instrumentation library information for the metrics in this message.

public getInstrumentationLibrary() : InstrumentationLibrary|null

Semantically when InstrumentationLibrary isn't set, it is equivalent with an empty instrumentation library name (unknown).

Generated from protobuf field .opentelemetry.proto.common.v1.InstrumentationLibrary instrumentation_library = 1;

Return values
InstrumentationLibrary|null

getMetrics()

A list of metrics that originate from an instrumentation library.

public getMetrics() : RepeatedField

Generated from protobuf field repeated .opentelemetry.proto.metrics.v1.Metric metrics = 2;

Return values
RepeatedField

getSchemaUrl()

This schema_url applies to all metrics in the "metrics" field.

public getSchemaUrl() : string

Generated from protobuf field string schema_url = 3;

Return values
string

setInstrumentationLibrary()

The instrumentation library information for the metrics in this message.

public setInstrumentationLibrary(InstrumentationLibrary $var) : $this

Semantically when InstrumentationLibrary isn't set, it is equivalent with an empty instrumentation library name (unknown).

Generated from protobuf field .opentelemetry.proto.common.v1.InstrumentationLibrary instrumentation_library = 1;

Parameters
$var : InstrumentationLibrary
Return values
$this

setMetrics()

A list of metrics that originate from an instrumentation library.

public setMetrics(array<string|int, Metric>|RepeatedField $var) : $this

Generated from protobuf field repeated .opentelemetry.proto.metrics.v1.Metric metrics = 2;

Parameters
$var : array<string|int, Metric>|RepeatedField
Return values
$this

setSchemaUrl()

This schema_url applies to all metrics in the "metrics" field.

public setSchemaUrl(string $var) : $this

Generated from protobuf field string schema_url = 3;

Parameters
$var : string
Return values
$this

        
On this page

Search results