OpenTelemetry PHP

MetricConfigResponse extends Message
in package

Generated from protobuf message <code>opentelemetry.proto.metrics.experimental.MetricConfigResponse</code>

Table of Contents

Properties

$fingerprint  : mixed
Optional. The fingerprint associated with this MetricConfigResponse. Each change in configs yields a different fingerprint. The resource SHOULD copy this value to MetricConfigRequest.last_known_fingerprint for the next configuration request. If there are no changes between fingerprint and MetricConfigRequest.last_known_fingerprint, then all other fields besides fingerprint in the response are optional, or the same as the last update if present.
$suggested_wait_time_sec  : mixed
Optional. The client is suggested to wait this long (in seconds) before pinging the configuration service again.
$schedules  : mixed
A single metric may match multiple schedules. In such cases, the schedule that specifies the smallest period is applied.

Methods

__construct()  : mixed
Constructor.
getFingerprint()  : string
Optional. The fingerprint associated with this MetricConfigResponse. Each change in configs yields a different fingerprint. The resource SHOULD copy this value to MetricConfigRequest.last_known_fingerprint for the next configuration request. If there are no changes between fingerprint and MetricConfigRequest.last_known_fingerprint, then all other fields besides fingerprint in the response are optional, or the same as the last update if present.
getSchedules()  : RepeatedField
A single metric may match multiple schedules. In such cases, the schedule that specifies the smallest period is applied.
getSuggestedWaitTimeSec()  : int
Optional. The client is suggested to wait this long (in seconds) before pinging the configuration service again.
setFingerprint()  : $this
Optional. The fingerprint associated with this MetricConfigResponse. Each change in configs yields a different fingerprint. The resource SHOULD copy this value to MetricConfigRequest.last_known_fingerprint for the next configuration request. If there are no changes between fingerprint and MetricConfigRequest.last_known_fingerprint, then all other fields besides fingerprint in the response are optional, or the same as the last update if present.
setSchedules()  : $this
A single metric may match multiple schedules. In such cases, the schedule that specifies the smallest period is applied.
setSuggestedWaitTimeSec()  : $this
Optional. The client is suggested to wait this long (in seconds) before pinging the configuration service again.

Properties

$fingerprint

Optional. The fingerprint associated with this MetricConfigResponse. Each change in configs yields a different fingerprint. The resource SHOULD copy this value to MetricConfigRequest.last_known_fingerprint for the next configuration request. If there are no changes between fingerprint and MetricConfigRequest.last_known_fingerprint, then all other fields besides fingerprint in the response are optional, or the same as the last update if present.

protected mixed $fingerprint = ''

The exact mechanics of generating the fingerprint is up to the implementation. However, a fingerprint must be deterministically determined by the configurations -- the same configuration will generate the same fingerprint on any instance of an implementation. Hence using a timestamp is unacceptable, but a deterministic hash is fine.

Generated from protobuf field bytes fingerprint = 1;

$suggested_wait_time_sec

Optional. The client is suggested to wait this long (in seconds) before pinging the configuration service again.

protected mixed $suggested_wait_time_sec = 0

Generated from protobuf field int32 suggested_wait_time_sec = 3;

$schedules

A single metric may match multiple schedules. In such cases, the schedule that specifies the smallest period is applied.

private mixed $schedules

Note, for optimization purposes, it is recommended to use as few schedules as possible to capture all required metric updates. Where you can be conservative, do take full advantage of the inclusion/exclusion patterns to capture as much of your targeted metrics.

Generated from protobuf field repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule schedules = 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 string $fingerprint
      Optional. The fingerprint associated with this MetricConfigResponse. Each
      change in configs yields a different fingerprint. The resource SHOULD copy
      this value to MetricConfigRequest.last_known_fingerprint for the next
      configuration request. If there are no changes between fingerprint and
      MetricConfigRequest.last_known_fingerprint, then all other fields besides
      fingerprint in the response are optional, or the same as the last update if
      present.
      The exact mechanics of generating the fingerprint is up to the
      implementation. However, a fingerprint must be deterministically determined
      by the configurations -- the same configuration will generate the same
      fingerprint on any instance of an implementation. Hence using a timestamp is
      unacceptable, but a deterministic hash is fine.
@type \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule[]|\Google\Protobuf\Internal\RepeatedField $schedules
      A single metric may match multiple schedules. In such cases, the schedule
      that specifies the smallest period is applied.
      Note, for optimization purposes, it is recommended to use as few schedules
      as possible to capture all required metric updates. Where you can be
      conservative, do take full advantage of the inclusion/exclusion patterns to
      capture as much of your targeted metrics.
@type int $suggested_wait_time_sec
      Optional. The client is suggested to wait this long (in seconds) before
      pinging the configuration service again.

}

getFingerprint()

Optional. The fingerprint associated with this MetricConfigResponse. Each change in configs yields a different fingerprint. The resource SHOULD copy this value to MetricConfigRequest.last_known_fingerprint for the next configuration request. If there are no changes between fingerprint and MetricConfigRequest.last_known_fingerprint, then all other fields besides fingerprint in the response are optional, or the same as the last update if present.

public getFingerprint() : string

The exact mechanics of generating the fingerprint is up to the implementation. However, a fingerprint must be deterministically determined by the configurations -- the same configuration will generate the same fingerprint on any instance of an implementation. Hence using a timestamp is unacceptable, but a deterministic hash is fine.

Generated from protobuf field bytes fingerprint = 1;

Return values
string

getSchedules()

A single metric may match multiple schedules. In such cases, the schedule that specifies the smallest period is applied.

public getSchedules() : RepeatedField

Note, for optimization purposes, it is recommended to use as few schedules as possible to capture all required metric updates. Where you can be conservative, do take full advantage of the inclusion/exclusion patterns to capture as much of your targeted metrics.

Generated from protobuf field repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule schedules = 2;

Return values
RepeatedField

getSuggestedWaitTimeSec()

Optional. The client is suggested to wait this long (in seconds) before pinging the configuration service again.

public getSuggestedWaitTimeSec() : int

Generated from protobuf field int32 suggested_wait_time_sec = 3;

Return values
int

setFingerprint()

Optional. The fingerprint associated with this MetricConfigResponse. Each change in configs yields a different fingerprint. The resource SHOULD copy this value to MetricConfigRequest.last_known_fingerprint for the next configuration request. If there are no changes between fingerprint and MetricConfigRequest.last_known_fingerprint, then all other fields besides fingerprint in the response are optional, or the same as the last update if present.

public setFingerprint(string $var) : $this

The exact mechanics of generating the fingerprint is up to the implementation. However, a fingerprint must be deterministically determined by the configurations -- the same configuration will generate the same fingerprint on any instance of an implementation. Hence using a timestamp is unacceptable, but a deterministic hash is fine.

Generated from protobuf field bytes fingerprint = 1;

Parameters
$var : string
Return values
$this

setSchedules()

A single metric may match multiple schedules. In such cases, the schedule that specifies the smallest period is applied.

public setSchedules(array<string|int, Schedule>|RepeatedField $var) : $this

Note, for optimization purposes, it is recommended to use as few schedules as possible to capture all required metric updates. Where you can be conservative, do take full advantage of the inclusion/exclusion patterns to capture as much of your targeted metrics.

Generated from protobuf field repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule schedules = 2;

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

setSuggestedWaitTimeSec()

Optional. The client is suggested to wait this long (in seconds) before pinging the configuration service again.

public setSuggestedWaitTimeSec(int $var) : $this

Generated from protobuf field int32 suggested_wait_time_sec = 3;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results