You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
The docstring for CFS_ES_PerfLogAdd makes no mention that the value of Marker is limited by the config value CFE_MISSION_ES_PERF_MAX_IDS.
In my case, I have never altered this limit and was not aware of its existence, so I was surprised when calls to the CFE_ES_PerfLogEntry were failing. The only way to know that this value is used is to check the implementation file at modules/es/fsw/src/cfe_es_perf.c or the note under from the documentation of sample_perfids.h:
Performance ids are limited to the range of 0 to CFE_MISSION_ES_PERF_MAX_IDS - 1.
This text should also appear in the docstring for CFE_ES_PerfLogAdd
I find this confusing because although the value does affect the size of the CFE_ES_HousekeepingTlm_Payload telemetry message via the filter and trigger mask buffers, the wording does not indicate that this limits the upper value of perfids, not the number of perfids. I could have only a few dozen perfids, but if one had a value greater than or equal to this parameter, it would be rejected.
Reporter Info
Isaac Rowe, NASA JSC (Jacobs Technology)
The text was updated successfully, but these errors were encountered:
Describe the bug
The docstring for CFS_ES_PerfLogAdd makes no mention that the value of
Marker
is limited by the config valueCFE_MISSION_ES_PERF_MAX_IDS
.In my case, I have never altered this limit and was not aware of its existence, so I was surprised when calls to the CFE_ES_PerfLogEntry were failing. The only way to know that this value is used is to check the implementation file at
modules/es/fsw/src/cfe_es_perf.c
or the note under from the documentation ofsample_perfids.h
:This text should also appear in the docstring for
CFE_ES_PerfLogAdd
I also find the documentation for
CFE_MISSION_ES_PERF_MAX_IDS
atmodules/es/config/default_cfe_es_interface_cfg.h
confusing:I find this confusing because although the value does affect the size of the
CFE_ES_HousekeepingTlm_Payload
telemetry message via the filter and trigger mask buffers, the wording does not indicate that this limits the upper value of perfids, not the number of perfids. I could have only a few dozen perfids, but if one had a value greater than or equal to this parameter, it would be rejected.Reporter Info
Isaac Rowe, NASA JSC (Jacobs Technology)
The text was updated successfully, but these errors were encountered: