Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace HttpProbeResultSummary

The results returned by running an HTTP probe. All times and durations are returned in milliseconds. All times are relative to the POSIX epoch (1970-01-01T00:00Z). Time properties conform to W3C Resource Timing. For more information, see PerformanceResourceTiming interface.

Properties

Optional connectEnd

connectEnd: undefined | number

The time immediately after the vantage point finishes establishing the connection to the server to retrieve the resource. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional connectStart

connectStart: undefined | number

The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional connection

connection: model.TcpConnection

Optional dns

dns: model.DNS

Optional domainLookupEnd

domainLookupEnd: undefined | number

The time immediately before the vantage point finishes the domain name lookup for the resource. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional domainLookupStart

domainLookupStart: undefined | number

The time immediately before the vantage point starts the domain name lookup for the resource. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional duration

duration: undefined | number

The total duration from start of request until response is fully consumed or the connection is closed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional encodedBodySize

encodedBodySize: undefined | number

The size, in octets, of the payload body prior to removing any applied content-codings. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional errorCategory

errorCategory: ErrorCategory

The category of error if an error occurs executing the probe. The {@code errorMessage} field provides a message with the error details.

  • NONE - No error
  • DNS - DNS errors
  • TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error.
  • NETWORK - Network-related errors, for example a "network unreachable" error.
  • SYSTEM - Internal system errors.

Optional errorMessage

errorMessage: undefined | string

The error information indicating why a probe execution failed.

Optional fetchStart

fetchStart: undefined | number

The time immediately before the vantage point starts to fetch the resource. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional isHealthy

isHealthy: undefined | false | true

True if the probe result is determined to be healthy based on probe type-specific criteria. For HTTP probes, a probe result is considered healthy if the HTTP response code is greater than or equal to 200 and less than 300.

Optional isTimedOut

isTimedOut: undefined | false | true

True if the probe did not complete before the configured {@code timeoutInSeconds} value.

Optional key

key: undefined | string

A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days.

Optional probeConfigurationId

probeConfigurationId: undefined | string

The OCID of the monitor or on-demand probe responsible for creating this result.

Optional protocol

protocol: model.HttpProbeProtocol

Optional requestStart

requestStart: undefined | number

The time immediately before the vantage point starts requesting the resource from the server. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional responseEnd

responseEnd: undefined | number

The time immediately after the vantage point receives the last byte of the response or immediately before the transport connection is closed, whichever comes first. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional responseStart

responseStart: undefined | number

The time immediately after the vantage point's HTTP parser receives the first byte of the response. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional secureConnectionStart

secureConnectionStart: undefined | number

The time immediately before the vantage point starts the handshake process to secure the current connection. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional startTime

startTime: undefined | number

The date and time the probe was executed, expressed in milliseconds since the POSIX epoch. This field is defined by the PerformanceResourceTiming interface of the W3C Resource Timing specification. For more information, see Resource Timing. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional statusCode

statusCode: undefined | number

The HTTP response status code. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional target

target: undefined | string

The target hostname or IP address of the probe.

Optional vantagePointName

vantagePointName: undefined | string

The name of the vantage point that executed the probe.

Functions

getDeserializedJsonObj

getJsonObj