BillingView

透過 Eventstream 回報帳單要求時顯示的訊息。

JSON 表示法
{
  "reportRequests": [
    {
      object (ReportRequest)
    }
  ]
}
欄位
reportRequests[]

object (ReportRequest)

要針對 cloud.eventstream.v2.ResourceEvent 回報的帳單要求

ReportRequest

services.report 方法的要求訊息。

JSON 表示法
{
  "serviceName": string,
  "operations": [
    {
      object (Operation)
    }
  ],
  "serviceConfigId": string
}
欄位
serviceName

string

服務名稱,如服務設定中所指定。例如 "pubsub.googleapis.com"

如要瞭解服務名稱的定義,請參閱 google.api.Service

operations[]

object (Operation)

要回報的作業。

一般來說,服務應為每個要求回報一項作業。您可以在單一要求中放入多項作業,但只有在報表產生時自然提供多項作業時,才應使用這項功能。

同一份 ReportRequest 中的作業數量沒有上限,但 ReportRequest 大小不得超過 1 MB。如要瞭解部分失敗行為,請參閱 ReportResponse.report_errors

serviceConfigId

string

指定要使用哪個版本的服務設定來處理要求。

如果未指定版本或找不到相符版本,系統會使用最新版本。

作業

代表作業相關資訊。

JSON 表示法
{
  "operationId": string,
  "operationName": string,
  "consumerId": string,
  "startTime": string,
  "endTime": string,
  "labels": {
    string: string,
    ...
  },
  "metricValueSets": [
    {
      object (MetricValueSet)
    }
  ],
  "logEntries": [
    {
      object (LogEntry)
    }
  ],
  "quotaProperties": {
    object (QuotaProperties)
  },
  "importance": enum (Importance),
  "userLabels": {
    string: string,
    ...
  },
  "resources": [
    {
      object (ResourceInfo)
    }
  ],
  "traceSpans": [
    {
      object (TraceSpan)
    }
  ]
}
欄位
operationId

string

作業的 ID。在產生作業的服務範圍內,這個值不得重複。如果服務在同一項作業中呼叫 services.check() 和 services.report(),這兩項呼叫應攜帶相同的 ID。

建議使用第 4 版 UUID,但並非必要。如果作業是根據現有資訊計算得出,且需要使用等冪 ID 進行重複資料刪除,建議使用 UUID 第 5 版。詳情請參閱 RFC 4122。

operationName

string

作業的完整名稱。保留欄位,供日後使用。

consumerId

string

使用服務的消費者身分。如果是消費者發起的作業,請填寫這個欄位;如果是服務發起的作業,且與特定消費者無關,則不必填寫。

  • 可以是下列其中一種格式:
    • project:PROJECT_ID,
    • project_number:PROJECT_NUMBER,
    • projects/PROJECT_ID 或 PROJECT_NUMBER,
    • folders/FOLDER_NUMBER,
    • organizations/ORGANIZATION_NUMBER,
    • api_key:API_KEY。
startTime

string (Timestamp format)

這是必要旗標,作業的開始時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

endTime

string (Timestamp format)

作業的結束時間。在 ServiceController.Report 中使用作業時為必填,但在 ServiceController.Check 中使用作業時為選填。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

labels

map (key: string, value: string)

說明作業的標籤。只能使用下列標籤:

  • 描述受監控資源的標籤,如服務設定中所定義。
  • 指標值的預設標籤。指定時,指標值中定義的標籤會覆寫這些預設值。
  • Google Cloud Platform 定義的標籤如下:
    • cloud.googleapis.com/location 說明作業發生位置,
    • servicecontrol.googleapis.com/userAgent 說明 API 要求的 User-Agent,
    • servicecontrol.googleapis.com/service_agent 說明用於處理 API 要求的服務 (例如 ESP),
    • servicecontrol.googleapis.com/platform 說明 API 服務平台,例如 App Engine、Compute Engine 或 Kubernetes Engine。

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

metricValueSets[]

object (MetricValueSet)

代表這項作業的相關資訊。每個 MetricValueSet 都對應於服務設定中定義的指標。MetricValueSet 中使用的資料類型必須與指標定義中指定的資料類型一致。

在單一作業中,不得有多個 MetricValue 執行個體具有相同的指標名稱和相同的標籤值組合。如果要求有這類重複的 MetricValue 執行個體,整個要求就會遭到拒絕,並顯示無效引數錯誤。

logEntries[]

object (LogEntry)

代表要記錄的資訊。

quotaProperties

object (QuotaProperties)

代表配額檢查所需的屬性。僅適用於配額檢查要求。如果未指定,系統就不會執行配額檢查。

importance

enum (Importance)

請勿使用。這是實驗欄位。

userLabels

map (key: string, value: string)

不公開預先發布版。這項功能僅適用於已核准的服務。

與這項作業相關聯的資源使用者定義標籤。

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

resources[]

object (ResourceInfo)

作業涉及的資源。這個欄位最多可支援 100 個項目。

traceSpans[]

object (TraceSpan)

未實作。Cloud Trace 範圍清單。跨度名稱應包含目的地專案的 ID,可以是生產或消費者專案。

MetricValueSet

代表同一指標中的一組指標值。該組中的每個指標值都應有不重複的開始時間、結束時間和標籤值組合。

JSON 表示法
{
  "metricName": string,
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}
欄位
metricName

string

服務設定中定義的指標名稱。

metricValues[]

object (MetricValue)

這項指標的值。

MetricValue

代表單一指標值。

JSON 表示法
{
  "labels": {
    string: string,
    ...
  },
  "startTime": string,
  "endTime": string,

  // Union field value can be only one of the following:
  "boolValue": boolean,
  "int64Value": string,
  "doubleValue": number,
  "stringValue": string,
  "distributionValue": {
    object (Distribution)
  },
  "moneyValue": {
    object (Money)
  }
  // End of list of possible types for union field value.
}
欄位
labels

map (key: string, value: string)

說明指標值的標籤。如需覆寫關係,請參閱 google.api.servicecontrol.v1.Operation.labels 的註解。請注意,這張地圖不得包含受監控的資源標籤。

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

startTime

string (Timestamp format)

這個指標值的評估適用時間範圍的開始時間。時間範圍的語意會因指標類型 (累計、增量和測量) 而異。詳情請參閱服務設定中的指標定義說明文件。如未指定,則會使用 google.api.servicecontrol.v1.Operation.start_time

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

endTime

string (Timestamp format)

這個指標值適用的測量時間範圍結尾。如未指定,則會使用 google.api.servicecontrol.v1.Operation.end_time

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

聯集欄位 value。值。要求中使用的值類型必須與服務設定中的指標定義一致,否則系統會拒絕 MetricValue。value 只能是下列其中一個設定:
boolValue

boolean

布林值。

int64Value

string (int64 format)

帶正負號的 64 位元整數值。

doubleValue

number

雙精度浮點值。

stringValue

string

文字字串值。

distributionValue

object (Distribution)

分布值。

moneyValue

object (Money)

金額值。

分布

Distribution 代表雙值樣本點的頻率分布。其中包含樣本點的人口數,以及其他選填資訊:

  • 樣本的算術平均值
  • 樣本的最小值和最大值
  • 樣本的平方差總和,用於計算變異數
  • 樣本點值的直方圖
JSON 表示法
{
  "count": string,
  "mean": number,
  "minimum": number,
  "maximum": number,
  "sumOfSquaredDeviation": number,
  "bucketCounts": [
    string
  ],
  "exemplars": [
    {
      object (Exemplar)
    }
  ],

  // Union field bucket_option can be only one of the following:
  "linearBuckets": {
    object (LinearBuckets)
  },
  "exponentialBuckets": {
    object (ExponentialBuckets)
  },
  "explicitBuckets": {
    object (ExplicitBuckets)
  }
  // End of list of possible types for union field bucket_option.
}
欄位
count

string (int64 format)

分配中的樣本總數。必須大於或等於 0。

mean

number

分佈中樣本的算術平均值。如果 count 為零,這個欄位就必須為零。

minimum

number

母體值的最小值。如果 count 為零,則會略過。

maximum

number

值母體的最大值。如果 count 為零,則會略過。

sumOfSquaredDeviation

number

離均差平方和:Sum[i=1..count]((x_i - mean)^2),其中每個 x_i 都是樣本值。如果 count 為零,則這個欄位必須為零,否則要求驗證會失敗。

bucketCounts[]

string (int64 format)

每個直方圖值區中的樣本數。bucketCounts 為選填欄位。如有提供,總和必須等於 count 值。

如要瞭解這些值,請參閱下方的 bucket_option。共有 N 個水桶。bucketCounts[0] 是指溢位 bucket 中的樣本數。bucketCounts[1]bucketCounts[N-1] 是每個有限值區中的樣本數。bucketCounts[N] 則是溢位值區中的樣本數。詳情請參閱下方的 bucket_option 留言。

可以省略任何尾碼的尾隨零。

exemplars[]

object (Exemplar)

例如:必須依 value 欄位遞增排序。

聯集欄位 bucket_option。定義直方圖中的值區。bucket_optionbucket_counts 必須同時設定或同時取消設定。

值區編號範圍為 [0, N],總共有 N+1 個值區。至少要有兩個值區 (單一值區的直方圖提供的資訊,count 已經提供)。

第一個 bucket 是下溢 bucket,下限為 -inf。最後一個分塊是溢位分塊,上限為 +inf。所有其他值區 (如有) 都稱為「有限」值區,因為這些值區有有限的下限和上限。如下所述,定義有限值區的方式有三種。

(1) 寬度固定的 bucket。(2) 寬度呈指數成長的 bucket。(3) 任意使用者提供的寬度值。

在所有情況下,值區都會涵蓋整個實數線 (-inf, +inf)。值區上限不含,下限則包含。欠位範圍的上限等於最小有限範圍的下限;溢位範圍的下限等於最大有限範圍的上限。bucket_option 只能是下列其中一項:

linearBuckets

object (LinearBuckets)

寬度固定的 bucket。

exponentialBuckets

object (ExponentialBuckets)

寬度呈指數成長的 bucket。

explicitBuckets

object (ExplicitBuckets)

bucket,寬度由使用者任意提供。

LinearBuckets

描述寬度固定的 bucket。

JSON 表示法
{
  "numFiniteBuckets": integer,
  "width": number,
  "offset": number
}
欄位
numFiniteBuckets

integer

有限值區數。加上欠位和溢位值區,值區總數為 numFiniteBuckets + 2。詳情請參閱 bucketOptions 的註解。

width

number

第 i 個線性值區涵蓋的間隔為 [offset + (i-1) * width, offset + i * width),其中 i 的範圍為 1 到 numFiniteBuckets (含)。必須為嚴格正數。

offset

number

第 i 個線性值區涵蓋的間隔為 [offset + (i-1) * width, offset + i * width),其中 i 的範圍為 1 到 numFiniteBuckets (含)。

ExponentialBuckets

描述寬度呈指數成長的 bucket。

JSON 表示法
{
  "numFiniteBuckets": integer,
  "growthFactor": number,
  "scale": number
}
欄位
numFiniteBuckets

integer

有限值區數。加上欠位和溢位值區,值區總數為 numFiniteBuckets + 2。詳情請參閱 bucketOptions 的註解。

growthFactor

number

第 i 個指數值區涵蓋的間隔為 [scale * growthFactor^(i-1), scale * growthFactor^i),其中 i 的範圍為 1 到 numFiniteBuckets (含)。必須大於 1.0。

scale

number

第 i 個指數值區涵蓋的間隔為 [scale * growthFactor^(i-1), scale * growthFactor^i),其中 i 的範圍為 1 到 numFiniteBuckets (含)。必須大於 0。

ExplicitBuckets

描述具有任意使用者提供寬度的 bucket。

JSON 表示法
{
  "bounds": [
    number
  ]
}
欄位
bounds[]

number

「bound」是值區之間嚴格遞增的界線清單。請注意,由於柵欄張貼,長度為 N-1 的清單會定義 N 個 bucket。詳情請參閱 bucketOptions 的註解。

第 i 個有限值區涵蓋的間隔為 [bound[i-1], bound[i]),其中 i 的範圍為 1 到 bound_size() - 1。請注意,如果「bound」只包含單一元素,則完全沒有有限值區;在這種特殊情況下,單一界限會定義欠位和溢位值區之間的界線。

值區編號下限上限 i == 0 (欠位) -inf bound[i] 0 < i < bound_size() bound[i-1] bound[i] i == bound_size() (溢位) bound[i-1] +inf

範例

範例點可用於註解匯總分布值。這類中繼資料會提供有關新增至 Distribution 值區的特定值資訊,例如新增值時處於活動狀態的追蹤 ID。可能包含更多資訊,例如範例值和時間戳記、來源等。

JSON 表示法
{
  "value": number,
  "timestamp": string,
  "attachments": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
欄位
value

number

範例點的值。這個值會決定範例所屬的值區。

timestamp

string (Timestamp format)

上述值的觀察 (取樣) 時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

attachments[]

object

範例值的背景資訊。例如:

追蹤:type.googleapis.com/google.monitoring.v3.SpanContext

字串常值:type.googleapis.com/google.protobuf.StringValue

在彙整期間捨棄的標籤:type.googleapis.com/google.monitoring.v3.DroppedLabels

單一範例中,每種訊息類型只能有一個附件,系統會強制執行這項規定。

包含任意類型欄位的物件。額外的 "@type" 欄位則包含能辨識類型的 URI。範例:{ "id": 1234, "@type": "types.example.com/standard/id" }

金額

代表金額與其貨幣類型。

JSON 表示法
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
欄位
currencyCode

string

ISO 4217 定義的貨幣代碼,由 3 個字母組成。

units

string (int64 format)

金額的整數單位。舉例來說,如果 currencyCode"USD",則 1 個單位為 1 美元。

nanos

integer

金額的奈米 (10^-9) 單位數量。這個值必須介於 -999,999,999 和 +999,999,999 (含) 之間。如果 units 為正值,nanos 必須為正值或零。如果 units 為零,則 nanos 可為正值、零或負值。如果 units 為負值,nanos 就必須為負值或零。例如,$-1.75 美元的表式方式為 units=-1 和 nanos=-750,000,000。

LogEntry

個別記錄項目。

JSON 表示法
{
  "name": string,
  "timestamp": string,
  "severity": enum (LogSeverity),
  "httpRequest": {
    object (HttpRequest)
  },
  "trace": string,
  "insertId": string,
  "labels": {
    string: string,
    ...
  },
  "operation": {
    object (LogEntryOperation)
  },
  "sourceLocation": {
    object (LogEntrySourceLocation)
  },

  // Union field payload can be only one of the following:
  "protoPayload": {
    "@type": string,
    field1: ...,
    ...
  },
  "textPayload": string,
  "structPayload": {
    object
  }
  // End of list of possible types for union field payload.
}
欄位
name

string

這是必要旗標,此記錄項目所屬的記錄。例如:"syslog""book_log"

timestamp

string (Timestamp format)

記錄項目描述的事件發生的時間。如果省略,預設為作業開始時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

severity

enum (LogSeverity)

記錄項目的嚴重性。預設值為 LogSeverity.DEFAULT

httpRequest

object (HttpRequest)

選用。與這個記錄項目相關聯的 HTTP 要求資訊 (如適用)。

trace

string

選用。記錄項目相關聯追蹤記錄的資源名稱 (如有)。如果這個欄位包含相對資源名稱,您可以假設該名稱是相對於 //tracing.googleapis.com。範例:projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824

insertId

string

用於重複資料刪除作業的記錄項目專屬 ID。如果省略此引數,實作項目會根據 operationId 產生一個。

labels

map (key: string, value: string)

一組使用者定義的 (鍵、值) 資料,可提供記錄項目的額外資訊。

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

operation

object (LogEntryOperation)

選用。與記錄項目相關聯的作業資訊 (如適用)。

sourceLocation

object (LogEntrySourceLocation)

選用。與記錄項目相關聯的原始碼位置資訊 (如有)。

聯集欄位 payload。記錄項目酬載,可以是多種型別之一。payload 只能是下列其中一個設定:
protoPayload

object

記錄項目酬載,以一個呈現為 JSON 物件的通訊協定緩衝區表示。目前唯一接受的類型為 AuditLog

包含任意類型欄位的物件。額外的 "@type" 欄位則包含能辨識類型的 URI。範例:{ "id": 1234, "@type": "types.example.com/standard/id" }

textPayload

string

記錄項目酬載,以 Unicode 字串 (UTF-8) 表示。

structPayload

object (Struct format)

記錄項目酬載,代表一個以 JSON 物件表示的架構。

HttpRequest

記錄 HTTP 要求的常見原型。僅包含 HTTP 規格定義的語意。產品專屬的記錄資訊必須在個別訊息中定義。

JSON 表示法
{
  "requestMethod": string,
  "requestUrl": string,
  "requestSize": string,
  "status": integer,
  "responseSize": string,
  "userAgent": string,
  "remoteIp": string,
  "serverIp": string,
  "referer": string,
  "latency": string,
  "cacheLookup": boolean,
  "cacheHit": boolean,
  "cacheValidatedWithOriginServer": boolean,
  "cacheFillBytes": string,
  "protocol": string
}
欄位
requestMethod

string

要求方法。例如:"GET""HEAD""PUT""POST"

requestUrl

string

要求的網址配置 (http、https)、主機名稱、路徑和查詢部分。範例:"http://example.com/some/info?color=red"

requestSize

string (int64 format)

HTTP 要求訊息的大小 (以位元組為單位),包括要求標頭和要求主體。

status

integer

指出回應狀態的回應代碼。例如:200、404。

responseSize

string (int64 format)

以位元組為單位,傳回給用戶端的 HTTP 回應訊息大小,包括回應標頭和回應內文。

userAgent

string

用戶端傳送的使用者代理程式。範例:"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"

remoteIp

string

發出 HTTP 要求的用戶端 IP 位址 (IPv4 或 IPv6)。例如:"192.168.1.1""FE80::0202:B3FF:FE1E:8329"

serverIp

string

要求傳送至來源伺服器的 IP 位址 (IPv4 或 IPv6)。

referer

string

要求的參照網址,如 HTTP/1.1 標頭欄位定義中所述。

latency

string (Duration format)

伺服器處理要求時的延遲時間,從收到要求到傳送回應為止。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「s」結尾,例如:"3.5s"

cacheLookup

boolean

是否嘗試進行快取查詢。

cacheHit

boolean

實體是否從快取提供 (無論是否經過驗證)。

cacheValidatedWithOriginServer

boolean

在從快取提供回應之前,是否已向原始伺服器驗證回應。只有在 cacheHit 為 True 時,這個欄位才有意義。

cacheFillBytes

string (int64 format)

插入快取的 HTTP 回應位元組數。只有在嘗試填入快取時才設定。

protocol

string

要求使用的通訊協定。例如:「HTTP/1.1」、「HTTP/2」、「websocket」

LogEntryOperation

與記錄項目相關聯的潛在長時間執行作業的其他資訊。

JSON 表示法
{
  "id": string,
  "producer": string,
  "first": boolean,
  "last": boolean
}
欄位
id

string

選用。任意作業 ID。具有相同 ID 的記錄項目會被視為同一項作業的一部分。

producer

string

選用。任意製作人 ID。idproducer 的組合不得重複。producer 的範例:"MyDivision.MyBigCompany.com""github.com/MyProject/MyApplication"

first

boolean

選用。如果這是作業中的第一個記錄項目,請將此值設為 True。

last

boolean

選用。如果這是作業中的最後一個記錄項目,請將此值設為 True。

LogEntrySourceLocation

產生記錄項目的原始碼位置相關額外資訊。

JSON 表示法
{
  "file": string,
  "line": string,
  "function": string
}
欄位
file

string

選用。來源檔案名稱。視執行階段環境而定,這可能是簡單名稱或完整名稱。

line

string (int64 format)

選用。來源檔案中的行。以 1 為基礎;0 表示沒有可用的行號。

function

string

選用。要叫用的函式或方法名稱,可讀性高,並可選擇性加入類別或套件名稱等環境資訊。這項資訊可能會用於記錄檢視器等情境,因為檔案和行號的意義較小。格式可能因語言而異。例如:qual.if.ied.Class.method (Java)、dir/package.func (Go)、function (Python)。

QuotaProperties

代表配額作業所需的屬性。

JSON 表示法
{
  "quotaMode": enum (QuotaMode)
}
欄位
quotaMode

enum (QuotaMode)

這項作業的配額模式。

ResourceInfo

說明與這項作業相關聯的資源。

JSON 表示法
{
  "resourceContainer": string,
  "resourceName": string,
  "resourceLocation": string,
  "permission": string
}
欄位
resourceContainer

string

這個資源例項的父項 ID。必須採用下列其中一種格式:- projects/<project-id or project-number>- folders/<folder-id>- organizations/<organization-id>

resourceName

string

資源名稱。這項資訊可用於稽核。

resourceLocation

string

資源位置。如果不是空白,系統會根據位置資訊政策檢查資源。值必須是有效的區域、地區或多地區。例如:「europe-west4」或「northamerica-northeast1-a」

permission

string

這項要求所需的資源權限。

TraceSpan

跨度代表追蹤記錄中的單一作業。跨度可以巢狀方式排列,形成追蹤樹狀結構。通常,追蹤記錄會包含描述端對端延遲時間的根範圍,以及子作業的一或多個子範圍。追蹤記錄也可以包含多個根範圍,或完全不含根範圍。跨度不一定要連續,追蹤記錄中的跨度之間可能會出現間隙或重疊。

JSON 表示法
{
  "name": string,
  "spanId": string,
  "parentSpanId": string,
  "displayName": {
    object (TruncatableString)
  },
  "startTime": string,
  "endTime": string,
  "attributes": {
    object (Attributes)
  },
  "status": {
    object (Status)
  },
  "sameProcessAsParentSpan": boolean,
  "childSpanCount": integer,
  "spanKind": enum (SpanKind)
}
欄位
name

string

範圍的資源名稱,格式如下:

projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]

[TRACE_ID] 是專案中追蹤記錄的唯一 ID,也就是 16 位元組陣列的 32 字元十六進位編碼。

[SPAN_ID] 是追蹤記錄中時距的專屬 ID,也就是 8 位元組陣列的 16 字元十六進位編碼。

spanId

string

跨度的資源名稱中的 [SPAN_ID] 部分。

parentSpanId

string

這個時距父項時距的 [SPAN_ID]。如果是根範圍,這個欄位必須留空。

displayName

object (TruncatableString)

範圍作業的說明 (最多 128 個位元組)。Stackdriver Trace 會在 Google Cloud Platform 主控台中顯示說明。舉例來說,顯示名稱可以是合格的方法名稱,也可以是作業呼叫所在的檔案名稱和行號。最佳做法是在應用程式內和相同的呼叫點使用相同的顯示名稱。方便您關聯不同追蹤記錄中的範圍。

startTime

string (Timestamp format)

時間範圍的開始時間。在用戶端,這是指本機的時間,也就是開始執行範圍的時間。在伺服器端,這是伺服器應用程式處理常式開始執行的時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

endTime

string (Timestamp format)

時間範圍的結束時間。在用戶端,這是指本機電腦記錄的跨度執行結束時間。在伺服器端,這是伺服器應用程式處理常式停止執行的時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

attributes

object (Attributes)

時距的一組屬性。每個範圍最多可有 32 個屬性。

status

object (Status)

這個時間範圍的最終狀態 (選填)。

sameProcessAsParentSpan

boolean

(選用) 設定這個參數,指出這個範圍是否與上層範圍位於相同程序。如未設定這項參數,Stackdriver Trace 就無法運用這項實用資訊。

childSpanCount

integer

這個範圍處於啟用狀態時產生的子範圍數量 (選填)。如果已設定,實作項目就能偵測缺少的子項範圍。

spanKind

enum (SpanKind)

區分特定環境中產生的範圍。舉例來說,您可以使用 CLIENT (呼叫端) 和 SERVER (被呼叫端) 識別 RPC 呼叫,區分兩個同名的範圍。

TruncatableString

代表可能縮短至指定長度的字串。

JSON 表示法
{
  "value": string,
  "truncatedByteCount": integer
}
欄位
value

string

縮短的字串。舉例來說,如果原始字串長度為 500 個位元組,字串長度上限為 128 個位元組,則 value 會包含 500 個位元組字串的前 128 個位元組。

系統一律會在 UTF8 字元界線截斷字串。如果字串中含有多位元組字元,縮短後的字串長度可能會小於大小限制。

truncatedByteCount

integer

從原始字串中移除的位元組數。如果這個值為 0,表示字串未縮短。

屬性

一組屬性,每個屬性的格式為 [KEY]:[VALUE]

JSON 表示法
{
  "attributeMap": {
    string: {
      object (AttributeValue)
    },
    ...
  },
  "droppedAttributesCount": integer
}
欄位
attributeMap

map (key: string, value: object (AttributeValue))

屬性集。每個屬性的鍵長度上限為 128 個位元組。值可以是最多 256 位元組的字串、帶正負號的 64 位元整數,或是布林值 truefalse。例如:

"/instance_id": "my-instance"
"/http/userAgent": ""
"/http/request_bytes": 300
"example.com/myattribute": true

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

droppedAttributesCount

integer

遭捨棄的屬性數量。屬性可能會因鍵過長或屬性過多而遭到捨棄。如果這個值為 0,則所有屬性都有效。

AttributeValue

[KEY]:[VALUE] 屬性中 [VALUE] 的允許類型。

JSON 表示法
{

  // Union field value can be only one of the following:
  "stringValue": {
    object (TruncatableString)
  },
  "intValue": string,
  "boolValue": boolean
  // End of list of possible types for union field value.
}
欄位
聯集欄位 value。值的類型。value 只能是下列其中一個設定:
stringValue

object (TruncatableString)

長度上限為 256 位元組的字串。

intValue

string (int64 format)

64 位元帶正負號整數。

boolValue

boolean

truefalse 表示的布林值。