blob: a7dac36338f9e472b0aad365baec3a3502916aad [file] [log] [blame] [edit]
# Copyright 2019 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
metric_definitions:
###############################################################################
# fuchsia networking
#
# All metrics are logged every 10 minutes as a result of Sampler forwarding
# Netstack's Inspect data.
###############################################################################
###############################################################################
# socket_count_max
#
# The number of open sockets on the system.
###############################################################################
- id: 15
# NB: The max in the name is slightly misleading, as the fleetwide report
# does not perform a max aggregation.
metric_name: socket_count_max
metric_type: INTEGER
metric_units_other: "sockets"
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
# NB: The max in the name is a misnomer.
- report_name: socket_count_max
id: 1
report_type: FLEETWIDE_HISTOGRAMS
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 8
initial_step: 25
step_multiplier: 2
- report_name: socket_count_per_device_max
id: 2
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
local_aggregation_procedure: MAX_PROCEDURE
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 8
initial_step: 25
step_multiplier: 2
###############################################################################
# sockets_created
#
# The number of sockets created since boot.
###############################################################################
- id: 28
metric_name: sockets_created
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
- report_name: sockets_created
id: 1
report_type: FLEETWIDE_OCCURRENCE_COUNTS
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
- report_name: sockets_created_per_device_max
id: 2
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 8
initial_step: 25
step_multiplier: 2
################################################################################
# sockets_destroyed
#
# The number of sockets destroyed since boot.
################################################################################
- id: 29
metric_name: sockets_destroyed
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
- report_name: sockets_destroyed
id: 1
report_type: FLEETWIDE_OCCURRENCE_COUNTS
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
- report_name: sockets_destroyed_per_device_max
id: 2
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 8
initial_step: 25
step_multiplier: 2
################################################################################
# packets_sent
#
# The number of packets sent since boot.
################################################################################
- id: 30
metric_name: packets_sent
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
- report_name: packets_sent
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 16
initial_step: 10
step_multiplier: 2
################################################################################
# packets_received
#
# The number of packets received since boot.
################################################################################
- id: 31
metric_name: packets_received
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
- report_name: packets_received
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 16
initial_step: 10
step_multiplier: 2
################################################################################
# bytes_sent
#
# The number of bytes sent since boot.
################################################################################
- id: 32
metric_name: bytes_sent
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
- report_name: bytes_sent
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 16
initial_step: 100
step_multiplier: 10
################################################################################
# bytes_received
#
# The number of bytes received since boot.
################################################################################
- id: 33
metric_name: bytes_received
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
- report_name: bytes_received
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 16
initial_step: 10
step_multiplier: 2
################################################################################
# tcp_connections_established_total
#
# The number of TCP connections established.
#
# Such a metric, when viewed over time, would help us understand the number of
# TCP connections that are building up in the system. A build-up can occur
# due to many long-lived sessions and/or TCP connections waiting to be
# purged by the stack. Such a wait occurs on passive close, waiting for
# application to initiate a close and on active close, waiting for certain
# timeouts to trigger.
#
# This is different from the socket_count_max metric above as the socket close
# and destruction triggered by the application is independent of the time TCP
# connections actually linger in the stack.
################################################################################
- id: 22
metric_name: tcp_connections_established_total
metric_type: INTEGER
metric_units_other: "tcp connections"
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
- report_name: tcp_connections_established_total
id: 1
report_type: FLEETWIDE_HISTOGRAMS
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 8
initial_step: 25
step_multiplier: 2
- report_name: tcp_connections_established_total_per_device_max
id: 2
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
local_aggregation_procedure: MAX_PROCEDURE
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 8
initial_step: 25
step_multiplier: 2
################################################################################
# tcp_connections_closed
#
# The number of established TCP connections that got closed because of passive
# or active TCP close by applications since boot.
################################################################################
- id: 34
metric_name: tcp_connections_closed
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
- report_name: tcp_connections_closed
id: 1
report_type: FLEETWIDE_OCCURRENCE_COUNTS
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
- report_name: tcp_connections_closed_per_device_max
id: 2
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 8
initial_step: 25
step_multiplier: 2
################################################################################
# tcp_connections_reset
#
# The number of established TCP connections that got aborted
# whenever a TCP RST was sent/received by the stack since boot.
################################################################################
- id: 35
metric_name: tcp_connections_reset
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
- report_name: tcp_connections_reset
id: 1
report_type: FLEETWIDE_OCCURRENCE_COUNTS
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
- report_name: tcp_connections_reset_per_device_max
id: 2
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 8
initial_step: 25
step_multiplier: 2
################################################################################
# tcp_connections_timed_out
#
# The number of established TCP connections that got closed
# because of TCP keepalive timeout expiry since boot.
################################################################################
- id: 36
metric_name: tcp_connections_timed_out
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
reports:
- report_name: tcp_connections_timed_out
id: 1
report_type: FLEETWIDE_OCCURRENCE_COUNTS
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
- report_name: tcp_connections_timed_out_per_device_max
id: 2
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 8
initial_step: 25
step_multiplier: 2
###############################################################################
# dhcp_v6_configuration
#
# The DHCPv6 configuration observed.
###############################################################################
- id: 26
metric_name: dhcp_v6_configuration
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
metric_dimensions:
- dimension: configuration_from_ndpra
event_codes:
0: no_configuration
1: managed_address
2: other_configurations
max_event_code: 7
reports:
- report_name: dhcp_v6_configuration
id: 1
report_type: UNIQUE_DEVICE_COUNTS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
local_aggregation_procedure: AT_LEAST_ONCE
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
- report_name: dhcp_v6_configuration_7_day_actives
id: 2
report_type: UNIQUE_DEVICE_COUNTS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_7_DAYS
local_aggregation_procedure: AT_LEAST_ONCE
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
###############################################################################
# available_dynamic_ipv6_address_config
#
# Whether IPv6 addresses are available via DHCPv6 and SLAAC.
###############################################################################
- id: 37
metric_name: available_dynamic_ipv6_address_config
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
metric_dimensions:
- dimension: dynamic_ipv6_address_source
event_codes:
0: no_global_slaac_or_dhcpv6_managed_address
1: global_slaac_only
2: dhcpv6_managed_address_only
3: global_slaac_and_dhcpv6_managed_address
reports:
- report_name: available_dynamic_ipv6_address_config
id: 1
report_type: UNIQUE_DEVICE_NUMERIC_STATS
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
- report_name: available_dynamic_ipv6_address_config_7_day_actives
id: 2
report_type: UNIQUE_DEVICE_NUMERIC_STATS
local_aggregation_period: WINDOW_7_DAYS
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
###############################################################################
# socket_option_operations_max
#
# The maximum number of times each socket option was get/set on a single socket
# since boot.
###############################################################################
- id: 38
metric_name: socket_option_operation_max
metric_type: INTEGER
metric_units_other: count
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
metric_dimensions:
- dimension: operation
event_codes:
0: unknown
1: get
2: set
- dimension: socket_option
event_codes:
0: unknown
1: accept_conn
2: add_ip_membership
3: add_ipv6membership
4: bind_to_device
5: broadcast
6: drop_ip_membership
7: drop_ipv6_membership
8: error
9: ip_multicast_interface
10: ip_multicast_loopback
11: ip_multicast_ttl
12: ip_packet_info
13: ip_receive_ttl
14: ip_receive_type_of_service
15: ip_ttl
16: ip_type_of_service
17: ipv6_multicast_hops
18: ipv6_multicast_interface
19: ipv6_multicast_loopback
20: ipv6_only
21: ipv6_receive_hop_limit
22: ipv6_receive_packet_info
23: ipv6_receive_traffic_class
24: ipv6_traffic_class
25: ipv6_unicast_hops
26: keep_alive
27: linger
28: no_check
29: out_of_band_inline
30: receive_buffer
31: reuse_address
32: reuse_port
33: send_buffer
34: tcp_congestion
35: tcp_cork
36: tcp_defer_accept
37: tcp_info
38: tcp_keep_alive_count
39: tcp_keep_alive_idle
40: tcp_keep_alive_interval
41: tcp_linger
42: tcp_max_segment
43: tcp_no_delay
44: tcp_quick_ack
45: tcp_syn_count
46: tcp_user_timeout
47: tcp_window_clamp
48: timestamp
reports:
- report_name: per_device_max
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
local_aggregation_procedure: MAX_PROCEDURE
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 1
num_buckets: 8
initial_step: 4
step_multiplier: 4
###############################################################################
# need_more_fragments
#
# The number of times since boot that the netstack has required more fragments
# to reassemble a packet.
###############################################################################
- id: 39
metric_name: need_more_fragments
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
metric_dimensions:
- dimension: ip_version
event_codes:
4: ipv4
6: ipv6
reports:
- report_name: per_device_histograms_1day
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 16
initial_step: 10
step_multiplier: 2
###############################################################################
# conntrack_num_connections
#
# The current number of connections currently being tracked by conntrack.
###############################################################################
- id: 40
metric_name: conntrack_num_connections
metric_type: INTEGER
metric_units_other: "connections"
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
metric_dimensions:
- dimension: ip_version
event_codes:
4: ipv4
6: ipv6
reports:
- report_name: per_device_histograms_1day
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
local_aggregation_procedure: MAX_PROCEDURE
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 16
initial_step: 10
step_multiplier: 2
###############################################################################
# conntrack_table_limit_hits
#
# The number of times since boot that the conntrack connection limit has been
# hit.
###############################################################################
- id: 41
metric_name: conntrack_table_limit_hits
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
metric_dimensions:
- dimension: ip_version
event_codes:
4: ipv4
6: ipv6
reports:
- report_name: per_device_histograms_1day
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 16
initial_step: 10
step_multiplier: 2
###############################################################################
# conntrack_table_limit_drops
#
# The number of times since boot that a packet has been dropped because room
# could not be made in the conntrack table.
###############################################################################
- id: 42
metric_name: conntrack_table_limit_drops
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
metric_dimensions:
- dimension: ip_version
event_codes:
4: ipv4
6: ipv6
reports:
- report_name: device_histogram
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
local_aggregation_period: WINDOW_1_DAY
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
int_buckets:
exponential:
floor: 0
num_buckets: 16
initial_step: 10
step_multiplier: 2
###############################################################################
# netstack migration metrics
#
# These metrics are extracted by sampler config from the stack migration
# component every hour.
###############################################################################
###############################################################################
# stack_migration_user_setting
#
# User-selected netstack version (through ffx and UI).
###############################################################################
- id: 500
metric_name: stack_migration_user_setting
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
metric_dimensions:
- dimension: netstack_version
event_codes:
1: no_selection
2: netstack2
3: netstack3
reports:
- report_name: num_devices
id: 1
report_type: UNIQUE_DEVICE_COUNTS
system_profile_selection: SELECT_FIRST
local_aggregation_period: WINDOW_1_DAY
local_aggregation_procedure: SELECT_FIRST
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
###############################################################################
# stack_migration_automated_setting
#
# Server-selected netstack version.
###############################################################################
- id: 501
metric_name: stack_migration_automated_setting
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
metric_dimensions:
- dimension: netstack_version
event_codes:
1: no_selection
2: netstack2
3: netstack3
reports:
- report_name: num_devices
id: 1
report_type: UNIQUE_DEVICE_COUNTS
system_profile_selection: SELECT_FIRST
local_aggregation_period: WINDOW_1_DAY
local_aggregation_procedure: SELECT_FIRST
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
###############################################################################
# stack_migration_current_boot
#
# The currently running netstack version.
###############################################################################
- id: 502
metric_name: stack_migration_current_boot
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING, NETWORK_COMMUNICATION]
meta_data:
max_release_stage: GA
expiration_date: "2025/03/01"
metric_dimensions:
- dimension: netstack_version
event_codes:
2: netstack2
3: netstack3
reports:
- report_name: num_devices
id: 1
report_type: UNIQUE_DEVICE_COUNTS
system_profile_selection: SELECT_FIRST
local_aggregation_period: WINDOW_1_DAY
local_aggregation_procedure: SELECT_FIRST
privacy_mechanism: DE_IDENTIFICATION
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
# Deleted metric IDs that must not be reused.
deleted_metric_ids: [1,2,3,4,5,6,7,8,9,10,11,12,13,14,16,17,18,19,20,21,23,24,25,27]