Home Get started Guides Concepts Reference Community

Overview FIDL Tools Kernel Tracing

fuchsia.cobalt

PROTOCOLS

MetricEventLoggerFactory

Defined in fuchsia.cobalt/cobalt.fidl

CreateMetricEventLogger

Request

Name	Type
`project_spec`	`ProjectSpec`
`logger`	`request<MetricEventLogger>`

Response

Name	Type
`status`	`Status`

LoggerFactory

Defined in fuchsia.cobalt/cobalt.fidl

CreateLoggerFromProjectId

Request

Name	Type
`project_id`	`uint32`
`logger`	`request<Logger>`

Response

Name	Type
`status`	`Status`

CreateLoggerSimpleFromProjectId

Request

Name	Type
`project_id`	`uint32`
`logger`	`request<LoggerSimple>`

Response

Name	Type
`status`	`Status`

MetricEventLogger

Defined in fuchsia.cobalt/cobalt.fidl

LogOccurrence

Request

Name	Type
`metric_id`	`uint32`
`count`	`uint64`
`event_codes`	`event_vector`

Response

Name	Type
`status`	`Status`

LogInteger

Request

Name	Type
`metric_id`	`uint32`
`value`	`int64`
`event_codes`	`event_vector`

Response

Name	Type
`status`	`Status`

LogIntegerHistogram

Request

Name	Type
`metric_id`	`uint32`
`histogram`	`integer_histogram`
`event_codes`	`event_vector`

Response

Name	Type
`status`	`Status`

LogString

Request

Name	Type
`metric_id`	`uint32`
`string_value`	`string[256]`
`event_codes`	`event_vector`

Response

Name	Type
`status`	`Status`

LogMetricEvents

Request

Name	Type
`events`	`vector<MetricEvent>[500]`

Response

Name	Type
`status`	`Status`

LogCustomEvent

Request

Name	Type
`metric_id`	`uint32`
`event_values`	`vector<CustomEventValue>`

Response

Name	Type
`status`	`Status`

LoggerBase

Defined in fuchsia.cobalt/cobalt.fidl

LoggerBase Interface

LogEvent

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`

Response

Name	Type
`status`	`Status`

LogEventCount

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`period_duration_micros`	`int64`
`count`	`int64`

Response

Name	Type
`status`	`Status`

LogElapsedTime

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`elapsed_micros`	`int64`

Response

Name	Type
`status`	`Status`

LogFrameRate

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`fps`	`float32`

Response

Name	Type
`status`	`Status`

LogMemoryUsage

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`bytes`	`int64`

Response

Name	Type
`status`	`Status`

StartTimer

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`timer_id`	`string[64]`
`timestamp`	`uint64`
`timeout_s`	`uint32`

Response

Name	Type
`status`	`Status`

EndTimer

Request

Name	Type
`timer_id`	`string[64]`
`timestamp`	`uint64`
`timeout_s`	`uint32`

Response

Name	Type
`status`	`Status`

Logger

Defined in fuchsia.cobalt/cobalt.fidl

LogEvent

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`

Response

Name	Type
`status`	`Status`

LogEventCount

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`period_duration_micros`	`int64`
`count`	`int64`

Response

Name	Type
`status`	`Status`

LogElapsedTime

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`elapsed_micros`	`int64`

Response

Name	Type
`status`	`Status`

LogFrameRate

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`fps`	`float32`

Response

Name	Type
`status`	`Status`

LogMemoryUsage

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`bytes`	`int64`

Response

Name	Type
`status`	`Status`

StartTimer

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`timer_id`	`string[64]`
`timestamp`	`uint64`
`timeout_s`	`uint32`

Response

Name	Type
`status`	`Status`

EndTimer

Request

Name	Type
`timer_id`	`string[64]`
`timestamp`	`uint64`
`timeout_s`	`uint32`

Response

Name	Type
`status`	`Status`

LogIntHistogram

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`histogram`	`vector<HistogramBucket>[500]`

Response

Name	Type
`status`	`Status`

LogCustomEvent

Request

Name	Type
`metric_id`	`uint32`
`event_values`	`vector<CustomEventValue>`

Response

Name	Type
`status`	`Status`

LogCobaltEvent

Request

Name	Type
`event`	`CobaltEvent`

Response

Name	Type
`status`	`Status`

LogCobaltEvents

Request

Name	Type
`events`	`vector<CobaltEvent>[500]`

Response

Name	Type
`status`	`Status`

LoggerSimple

Defined in fuchsia.cobalt/cobalt.fidl

LoggerSimple Interface

LogEvent

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`

Response

Name	Type
`status`	`Status`

LogEventCount

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`period_duration_micros`	`int64`
`count`	`int64`

Response

Name	Type
`status`	`Status`

LogElapsedTime

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`elapsed_micros`	`int64`

Response

Name	Type
`status`	`Status`

LogFrameRate

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`fps`	`float32`

Response

Name	Type
`status`	`Status`

LogMemoryUsage

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`bytes`	`int64`

Response

Name	Type
`status`	`Status`

StartTimer

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`timer_id`	`string[64]`
`timestamp`	`uint64`
`timeout_s`	`uint32`

Response

Name	Type
`status`	`Status`

EndTimer

Request

Name	Type
`timer_id`	`string[64]`
`timestamp`	`uint64`
`timeout_s`	`uint32`

Response

Name	Type
`status`	`Status`

LogIntHistogram

Request

Name	Type
`metric_id`	`uint32`
`event_code`	`uint32`
`component`	`string[64]`
`bucket_indices`	`vector<uint32>[500]`
`bucket_counts`	`vector<uint64>[500]`

Response

Name	Type
`status`	`Status`

SystemDataUpdater

Defined in fuchsia.cobalt/cobalt.fidl

SetExperimentState

Request

Name	Type
`experiments`	`vector<Experiment>`

Response

Name	Type
`status`	`Status`

SetChannel

Request

Name	Type
`current_channel`	`string[256]`

Response

Name	Type
`status`	`Status`

Controller

Defined in fuchsia.cobalt/cobalt_controller.fidl

RequestSendSoon

Request

Name	Type

Response

Name	Type
`success`	`bool`

BlockUntilEmpty

Request

Name	Type
`max_wait_seconds`	`uint32`

Response

Name	Type

GetNumSendAttempts

Request

Name	Type

Response

Name	Type
`num`	`uint32`

GetFailedSendAttempts

Request

Name	Type

Response

Name	Type
`num`	`uint32`

GetNumObservationsAdded

Request

Name	Type

Response

Name	Type
`num_obs`	`uint64`

GetNumEventAggregatorRuns

Request

Name	Type

Response

Name	Type
`num_runs`	`uint64`

GenerateAggregatedObservations

Request

Name	Type
`day_index`	`uint32`
`report_ids`	`vector<uint32>`

Response

Name	Type
`num_obs`	`vector<uint64>`

STRUCTS

MetricEvent

Defined in fuchsia.cobalt/cobalt.fidl

Name	Type	Description	Default
`metric_id`	`uint32`		No default
`event_codes`	`event_vector`		No default
`payload`	`MetricEventPayload`		No default

CustomEventValue

Defined in fuchsia.cobalt/cobalt.fidl

Logger Interface

Name	Type	Description	Default
`dimension_name`	`string`		No default
`value`	`Value`		No default

HistogramBucket

Defined in fuchsia.cobalt/cobalt.fidl

Name	Type	Description	Default
`index`	`uint32`		No default
`count`	`uint64`		No default

CountEvent

Defined in fuchsia.cobalt/cobalt.fidl

Name	Type	Description	Default
`period_duration_micros`	`int64`		No default
`count`	`int64`		No default

Event

Defined in fuchsia.cobalt/cobalt.fidl

Name	Type	Description	Default

CobaltEvent

Defined in fuchsia.cobalt/cobalt.fidl

Name	Type	Description	Default
`metric_id`	`uint32`		No default
`event_codes`	`vector<uint32>[5]`		No default
`component`	`string[64]?`		No default
`payload`	`EventPayload`		No default

Experiment

Defined in fuchsia.cobalt/cobalt.fidl

SystemProfileUpdater Interface

Name	Type	Description	Default
`experiment_id`	`uint64`		No default
`arm_id`	`uint32`		No default

ENUMS

Status

Type: int32

Defined in fuchsia.cobalt/cobalt.fidl

Name	Value	Description
`OK`	`0`
`INVALID_ARGUMENTS`	`1`
`EVENT_TOO_BIG`	`2`
`BUFFER_FULL`	`3`
`INTERNAL_ERROR`	`-1`

TABLES

ProjectSpec

Defined in fuchsia.cobalt/cobalt.fidl

Ordinal	Name	Type	Description
1	`customer_id`	`uint32`
2	`project_id`	`uint32`

UNIONS

MetricEventPayload

Defined in fuchsia.cobalt/cobalt.fidl

Name	Type	Description
`count`	`uint64`
`integer_value`	`int64`
`histogram`	`integer_histogram`
`string_value`	`string[256]`

Value

Defined in fuchsia.cobalt/cobalt.fidl

Name	Type	Description
`string_value`	`string`
`int_value`	`int64`
`double_value`	`float64`
`index_value`	`uint32`

EventPayload

Defined in fuchsia.cobalt/cobalt.fidl

Name	Type	Description
`event`	`Event`
`event_count`	`CountEvent`
`elapsed_micros`	`int64`
`fps`	`float32`
`memory_bytes_used`	`int64`

`int_histogram`	`vector<HistogramBucket>[500]`

CONSTANTS

Name	Value	Type	Description
MAX_BYTES_PER_EVENT	`102400`	`int64`
MAX_HISTOGRAM_BUCKETS	`500`	`uint32`
MAX_BATCHED_EVENTS	`500`	`uint32`
MAX_COMPONENT_LENGTH	`64`	`uint32`
MAX_TIMER_ID_LENGTH	`64`	`uint32`
MAX_STRING_EVENT_SIZE	`256`	`uint32`
MAX_EVENT_CODE_COUNT	`5`	`uint32`
MAX_METRIC_DIMENSIONS	`10`	`uint32`
MAX_CHANNEL_NAME_LENGTH	`256`	`uint32`

TYPE ALIASES

Name	Value	Description
event_vector	`vector`[`MAX_METRIC_DIMENSIONS`]
integer_histogram	`vector`[`MAX_HISTOGRAM_BUCKETS`]

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2020-03-27.