REST Resource: projects.locations.sources.errorFrames

Resource: ErrorFrame

Message representing a frame which failed to be processed due to an error.

JSON representation 
{
  "name": string,
  "violations": [
    {
      object (FrameViolationEntry)
    }
  ],
  "originalFrame": {
    object (AssetFrame)
  },
  "ingestionTime": string
}
Fields
name

string

Output only. The identifier of the ErrorFrame.
violations[]

object (FrameViolationEntry)

Output only. All the violations that were detected for the frame.
originalFrame

object (AssetFrame)

Output only. The frame that was originally reported.
ingestionTime

string (Timestamp format)

Output only. Frame ingestion time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

FrameViolationEntry

A resource that contains a single violation of a reported AssetFrame resource.

JSON representation 
{
  "field": string,
  "violation": string
}
Fields
field

string

The field of the original frame where the violation occurred.
violation

string

A message describing the violation.

AssetFrame

Contains data reported from an inventory source on an asset.

JSON representation 
{
  "reportTime": string,
  "labels": {
    string: string,
    ...
  },
  "attributes": {
    string: string,
    ...
  },
  "performanceSamples": [
    {
      object (PerformanceSample)
    }
  ],
  "traceToken": string,
  "collectionType": enum (SourceType),

  // Union field FrameData can be only one of the following:
  "machineDetails": {
    object (MachineDetails)
  },
  "databaseDeploymentDetails": {
    object (DatabaseDeploymentDetails)
  },
  "databaseDetails": {
    object (DatabaseDetails)
  }
  // End of list of possible types for union field FrameData.
}
Fields
reportTime

string (Timestamp format)

The time the data was reported.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
attributes

map (key: string, value: string)

Generic asset attributes.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
performanceSamples[]

object (PerformanceSample)

Asset performance data samples. Samples that are from more than 40 days ago or after tomorrow are ignored.
traceToken

string

Optional. Trace token is optionally provided to assist with debugging and traceability.
collectionType

enum (SourceType)

Optional. Frame collection type, if not specified the collection type will be based on the source type of the source the frame was reported on.
Union field FrameData. The internal data of the frame is a oneof field depending on the type of asset information in the frame. FrameData can be only one of the following:
machineDetails

object (MachineDetails)

Asset information specific for virtual machines.
databaseDeploymentDetails

object (DatabaseDeploymentDetails)

Asset information specific for database deployments.
databaseDetails

object (DatabaseDetails)

Asset information specific for logical databases.

PerformanceSample

Performance data sample.

JSON representation 
{
  "sampleTime": string,
  "memory": {
    object (MemoryUsageSample)
  },
  "cpu": {
    object (CpuUsageSample)
  },
  "network": {
    object (NetworkUsageSample)
  },
  "disk": {
    object (DiskUsageSample)
  }
}
Fields
sampleTime

string (Timestamp format)

Time the sample was collected. If omitted, the frame report time will be used.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
memory

object (MemoryUsageSample)

Memory usage sample.
cpu

object (CpuUsageSample)

CPU usage sample.
network

object (NetworkUsageSample)

Network usage sample.
disk

object (DiskUsageSample)

Disk usage sample.

MemoryUsageSample

Memory usage sample.

JSON representation 
{
  "utilizedPercentage": number
}
Fields
utilizedPercentage

number

Percentage of system memory utilized. Must be in the interval [0, 100].

CpuUsageSample

CPU usage sample.

JSON representation 
{
  "utilizedPercentage": number
}
Fields
utilizedPercentage

number

Percentage of total CPU capacity utilized. Must be in the interval [0, 100]. On most systems can be calculated using 100 - idle percentage.

NetworkUsageSample

Network usage sample. Values are across all network interfaces.

JSON representation 
{
  "averageIngressBps": number,
  "averageEgressBps": number
}
Fields
averageIngressBps

number

Average network ingress in B/s sampled over a short window. Must be non-negative.
averageEgressBps

number

Average network egress in B/s sampled over a short window. Must be non-negative.

DiskUsageSample

Disk usage sample. Values are across all disks.

JSON representation 
{
  "averageIops": number,
  "averageReadIops": number,
  "averageWriteIops": number
}
Fields
averageIops

number

Optional. Average IOPS sampled over a short window. Must be non-negative. Must be equal to the sum of read and write if one of them is positive. if both read and write are zero they are ignored.
averageReadIops

number

Optional. Average read IOPS sampled over a short window. Must be non-negative.
averageWriteIops

number

Optional. Average write IOPS sampled over a short window. Must be non-negative.

Methods

get

 Gets the details of an error frame.

list

 Lists all error frames in a given source and location.