[#BloombergLP-ball-Administration]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::Administration
:relfileprefix: ../../
:mrdocs:

This `struct` provides a namespace for logging administration utilities.

== Synopsis

Declared in `<ball_administration.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct Administration;
----

== Description

This `struct` provides a namespace for a suite of utility functions that simplifies administration of the `ball` logging subsystem, and insulates administrative clients from changes to lower‐level components of the `ball` package. A precondition common to all of the utility functions is that the logger manager singleton must be initialized and not in the process of being shut down.

== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/Administration/addCategory.adoc[`addCategory`] 
| Add a new category with the specified name and threshold levels.
| xref:BloombergLP/ball/Administration/defaultPassThresholdLevel.adoc[`defaultPassThresholdLevel`] 
| Return the default pass threshold level.
| xref:BloombergLP/ball/Administration/defaultRecordThresholdLevel.adoc[`defaultRecordThresholdLevel`] 
| Return the default record threshold level.
| xref:BloombergLP/ball/Administration/defaultTriggerAllThresholdLevel.adoc[`defaultTriggerAllThresholdLevel`] 
| Return the default trigger‐all threshold level.
| xref:BloombergLP/ball/Administration/defaultTriggerThresholdLevel.adoc[`defaultTriggerThresholdLevel`] 
| Return the default trigger threshold level.
| xref:BloombergLP/ball/Administration/maxNumCategories.adoc[`maxNumCategories`] 
| Return the current capacity of the category registry.
| xref:BloombergLP/ball/Administration/numCategories.adoc[`numCategories`] 
| Return the number of categories in the registry.
| xref:BloombergLP/ball/Administration/passLevel.adoc[`passLevel`] 
| Return the pass threshold level for the named category.
| xref:BloombergLP/ball/Administration/recordLevel.adoc[`recordLevel`] 
| Return the record threshold level for the named category.
| xref:BloombergLP/ball/Administration/resetDefaultThresholdLevels.adoc[`resetDefaultThresholdLevels`] 
| Reset the default threshold levels to factory values.
| xref:BloombergLP/ball/Administration/setAllThresholdLevels.adoc[`setAllThresholdLevels`] 
| Set default and existing category threshold levels.
| xref:BloombergLP/ball/Administration/setDefaultThresholdLevels.adoc[`setDefaultThresholdLevels`] 
| Set the default threshold levels.
| xref:BloombergLP/ball/Administration/setMaxNumCategories.adoc[`setMaxNumCategories`] 
| Set the capacity of the category registry.
| xref:BloombergLP/ball/Administration/setThresholdLevels.adoc[`setThresholdLevels`] 
| Set threshold levels for categories matching a pattern.
| xref:BloombergLP/ball/Administration/triggerAllLevel.adoc[`triggerAllLevel`] 
| Return the trigger‐all threshold level for the named category.
| xref:BloombergLP/ball/Administration/triggerLevel.adoc[`triggerLevel`] 
| Return the trigger threshold level for the named category.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#