Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class ObservabilityInstanceConfig.
Observability Instance specific configuration.
Generated from protobuf message google.cloud.alloydb.v1.Instance.ObservabilityInstanceConfig
Namespace
Google \ Cloud \ AlloyDb \ V1 \ InstanceMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ enabled |
bool
Observability feature status for an instance. This flag is turned "off" by default. |
↳ preserve_comments |
bool
Preserve comments in query string for an instance. This flag is turned "off" by default. |
↳ track_wait_events |
bool
Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. |
↳ track_wait_event_types |
bool
Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. |
↳ max_query_string_length |
int
Query string length. The default value is 10k. |
↳ record_application_tags |
bool
Record application tags for an instance. This flag is turned "off" by default. |
↳ query_plans_per_minute |
int
Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. |
↳ track_active_queries |
bool
Track actively running queries on the instance. If not set, this flag is "off" by default. |
getEnabled
Observability feature status for an instance.
This flag is turned "off" by default.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasEnabled
clearEnabled
setEnabled
Observability feature status for an instance.
This flag is turned "off" by default.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPreserveComments
Preserve comments in query string for an instance.
This flag is turned "off" by default.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasPreserveComments
clearPreserveComments
setPreserveComments
Preserve comments in query string for an instance.
This flag is turned "off" by default.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrackWaitEvents
Track wait events during query execution for an instance.
This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasTrackWaitEvents
clearTrackWaitEvents
setTrackWaitEvents
Track wait events during query execution for an instance.
This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrackWaitEventTypes
Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasTrackWaitEventTypes
clearTrackWaitEventTypes
setTrackWaitEventTypes
Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxQueryStringLength
Query string length. The default value is 10k.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasMaxQueryStringLength
clearMaxQueryStringLength
setMaxQueryStringLength
Query string length. The default value is 10k.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRecordApplicationTags
Record application tags for an instance.
This flag is turned "off" by default.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasRecordApplicationTags
clearRecordApplicationTags
setRecordApplicationTags
Record application tags for an instance.
This flag is turned "off" by default.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQueryPlansPerMinute
Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200.
Any integer between 0 to 200 is considered valid.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasQueryPlansPerMinute
clearQueryPlansPerMinute
setQueryPlansPerMinute
Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200.
Any integer between 0 to 200 is considered valid.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrackActiveQueries
Track actively running queries on the instance.
If not set, this flag is "off" by default.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasTrackActiveQueries
clearTrackActiveQueries
setTrackActiveQueries
Track actively running queries on the instance.
If not set, this flag is "off" by default.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|