Public Attributes
int32_t	_canary

ecs_entity_t	entity
	Entity associated with metric. More...

ecs_entity_t	member
	Entity associated with member that stores metric value. More...

const char *	dotmember

ecs_id_t	id
	Tracks whether entities have the specified component id. More...

bool	targets
	If id is a (R, *) wildcard and relationship R has the OneOf property, setting this value to true will track individual targets. More...

ecs_entity_t	kind
	Must be EcsGauge, EcsCounter, EcsCounterIncrement or EcsCounterId. More...

const char *	brief
	Description of metric. More...

Detailed Description

Definition at line 72 of file metrics.h.

Member Data Documentation

◆ _canary

int32_t ecs_metric_desc_t::_canary

Definition at line 73 of file metrics.h.

◆ brief

const char* ecs_metric_desc_t::brief

Description of metric.

Will only be set if FLECS_DOC addon is enabled

Definition at line 101 of file metrics.h.

◆ dotmember

const char* ecs_metric_desc_t::dotmember

Definition at line 85 of file metrics.h.

◆ entity

ecs_entity_t ecs_metric_desc_t::entity

Entity associated with metric.

Definition at line 76 of file metrics.h.

◆ id

ecs_id_t ecs_metric_desc_t::id

Tracks whether entities have the specified component id.

Must not be set at the same time as member.

Definition at line 89 of file metrics.h.

◆ kind

ecs_entity_t ecs_metric_desc_t::kind

Must be EcsGauge, EcsCounter, EcsCounterIncrement or EcsCounterId.

Definition at line 98 of file metrics.h.

◆ member

ecs_entity_t ecs_metric_desc_t::member

Entity associated with member that stores metric value.

Must not be set at the same time as id. Cannot be combined with EcsCounterId.

Definition at line 80 of file metrics.h.

◆ targets

bool ecs_metric_desc_t::targets

If id is a (R, *) wildcard and relationship R has the OneOf property, setting this value to true will track individual targets.

If the kind is EcsCountId and the id is a (R, *) wildcard, this value will create a metric per target.

Definition at line 95 of file metrics.h.

The documentation for this struct was generated from the following file:

include/flecs/addons/metrics.h

Public Attributes