Method: projects.locations.insights.writeInsight

Write the data insights to workload manager data warehouse.

HTTP request

POST https://workloadmanager.googleapis.com/v1/{location=projects/*/locations/*}/insights:writeInsight

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
location

string

Required. The GCP location. The format is: projects/{project}/locations/{location}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "insight": {
    object (Insight)
  },
  "requestId": string
}
Fields
insight

object (Insight)

Required. The metrics data details.
requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Response body

If successful, the response body is empty.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

Insight

A presentation of host resource usage where the workload runs.

JSON representation 
{
  "sentTime": string,

  // Union field type can be only one of the following:
  "sapValidation": {
    object (SapValidation)
  },
  "sapDiscovery": {
    object (SapDiscovery)
  },
  "sqlserverValidation": {
    object (SqlserverValidation)
  }
  // End of list of possible types for union field type.
}
Fields
sentTime

string (Timestamp format)

Output only. [Output only] Create time stamp

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".

Union field type.

type can be only one of the following:
sapValidation

object (SapValidation)

The insights data for the sap workload validation.
sapDiscovery

object (SapDiscovery)

The insights data for sap system discovery. This is a copy of SAP System proto and should get updated whenever that one changes.
sqlserverValidation

object (SqlserverValidation)

The insights data for the sqlserver workload validation.

SapValidation

A presentation of SAP workload insight. The schema of SAP workloads validation related data.

JSON representation 
{
  "validationDetails": [
    {
      object (ValidationDetail)
    }
  ]
}
Fields
validationDetails[]

object (ValidationDetail)

A list of SAP validation metrics data.

ValidationDetail

Message describing the SAP validation metrics.

JSON representation 
{
  "sapValidationType": enum (SapValidationType),
  "details": {
    string: string,
    ...
  }
}
Fields
sapValidationType

enum (SapValidationType)

The SAP system that the validation data is from.
details

map (key: string, value: string)

The <k,v> pairs of metrics data: field name & field value.

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

SapValidationType

The different SAP systems.

Enums
SAP_VALIDATION_TYPE_UNSPECIFIED Unspecified type.
SYSTEM The SAP system named SYSTEM.
COROSYNC The SAP system named COROSYNC.
PACEMAKER The SAP system named PACEMAKER.
HANA The SAP system named HANA.
NETWEAVER The SAP system named NETWEAVER.

SapDiscovery

The schema of SAP system discovery data.

JSON representation 
{
  "metadata": {
    object (Metadata)
  },
  "databaseLayer": {
    object (Component)
  },
  "applicationLayer": {
    object (Component)
  },
  "systemId": string,
  "updateTime": string
}
Fields
metadata

object (Metadata)

The metadata for SAP system discovery data.
databaseLayer

object (Component)

An SAP System must have a database.
applicationLayer

object (Component)

An SAP system may run without an application layer.
systemId

string

A combination of database SID, database instance URI and tenant DB name to make a unique identifier per-system.
updateTime

string (Timestamp format)

Unix timestamp this system has been updated last.

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".

Metadata

Message describing SAP discovery system metadata

JSON representation 
{
  "definedSystem": string,
  "sapProduct": string,
  "environmentType": string,
  "customerRegion": string
}
Fields
definedSystem

string

Customer defined, something like "E-commerce pre prod"
sapProduct

string

This sap product name
environmentType

string

Should be "prod", "QA", "dev", "staging", etc.
customerRegion

string

Customer region string for customer's use. Does not represent GCP region.

Component

Message describing the system component.

JSON representation 
{
  "resources": [
    {
      object (Resource)
    }
  ],
  "hostProject": string,
  "sid": string,

  // Union field type can be only one of the following:
  "applicationType": string,
  "databaseType": string
  // End of list of possible types for union field type.
}
Fields
resources[]

object (Resource)

The resources in a component.
hostProject

string

Pantheon Project in which the resources reside.
sid

string

The sap identifier, used by the SAP software and helps differentiate systems for customers.

Union field type.

type can be only one of the following:
applicationType

string

The component is a SAP application.
databaseType

string

The component is a SAP database.

Resource

Message describing a resource.

JSON representation 
{
  "resourceType": enum (ResourceType),
  "resourceKind": string,
  "resourceUri": string,
  "relatedResources": [
    string
  ],
  "updateTime": string
}
Fields
resourceType

enum (ResourceType)

The type of this resource.
resourceKind

string

ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
resourceUri

string

URI of the resource, includes project, location, and name.
relatedResources[]

string

A list of resource URIs related to this resource.
updateTime

string (Timestamp format)

Unix timestamp of when this resource last had its discovery data updated.

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".

ResourceType

Different types of resources attached to the SAP system.

Enums
RESOURCE_TYPE_UNSPECIFIED Undefined resource type.
COMPUTE This is a compute resource.
STORAGE This a storage resource.
NETWORK This is a network resource.

SqlserverValidation

A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data.

JSON representation 
{
  "agentVersion": string,
  "validationDetails": [
    {
      object (ValidationDetail)
    }
  ]
}
Fields
agentVersion

string

The agent version collected this data point
validationDetails[]

object (ValidationDetail)

A list of SqlServer validation metrics data.

ValidationDetail

Message describing the Sqlserver validation metrics.

JSON representation 
{
  "type": enum (SqlserverValidationType),
  "instanceId": string,
  "details": {
    string: string,
    ...
  }
}
Fields
type

enum (SqlserverValidationType)

The Sqlserver system that the validation data is from.
instanceId

string

The instance id where the ValidationDetail is generated from
details

map (key: string, value: string)

The <k,v> pairs of metrics data: field name & field value.

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

SqlserverValidationType

The different SqlServer systems.

Enums
SQLSERVER_VALIDATION_TYPE_UNSPECIFIED Unspecified type.
OS The Sqlserver system named OS
DB The Sqlserver system named DB