endstone.metrics.base

Classes

Name	Description
`MetricsBase`	The MetricsBase class to handle sending metrics to bStats.

`class`MetricsBase

Bases: ABC

MetricsBase(platform: str, server_uuid: UUID, service_id: int, log_errors: bool, log_sent_data: bool, log_response_status_text: bool)

The MetricsBase class to handle sending metrics to bStats.

Attributes

Name	Type	Description
`METRICS_VERSION`	`str`	The version of the Metrics class.
`REPORT_URL`	`str`	The URL to which data is reported.

Parameters

Name	Type	Description	Default
`platform`	`str`	The platform of the service.	required
`server_uuid`	`UUID`	The server UUID.	required
`service_id`	`int`	The service ID.	required
`log_errors`	`bool`	Whether errors should be logged.	required
`log_sent_data`	`bool`	Whether the data sent should be logged.	required
`log_response_status_text`	`bool`	Whether the response status text should be logged.	required

Methods

Name	Description
`add_custom_chart`	Adds a custom chart.
`append_platform_data`	Append platform-specific data.
`append_service_data`	Append service-specific data.
`log_error`	Logs error message.
`log_info`	Logs info message.
`shutdown`
`submit_task`	Submit the given task

`attr`METRICS_VERSION

METRICS_VERSION = '3.0.3'

`attr`REPORT_URL

REPORT_URL = 'https://bStats.org/api/v2/data/{platform}'

`attr`enabledabstractmethodproperty

enabled: bool

Whether data sending is enabled.

`attr`service_enabledabstractmethodproperty

service_enabled: bool

Whether the service is enabled.

`meth`add_custom_chart

add_custom_chart(chart: Any)

Adds a custom chart.

Parameters

Name	Type	Description	Default
`chart`	`Any`	The custom chart to add.	required

`meth`append_platform_data

append_platform_data(data: Dict[str, Any]) -> None

Append platform-specific data.

Parameters

Name	Type	Description	Default
`data`	`Dict[str, Any]`	The data to append platform-specific values to.	required

`meth`append_service_data

append_service_data(data: Dict[str, Any]) -> None

Append service-specific data.

Parameters

Name	Type	Description	Default
`data`	`Dict[str, Any]`	The data to append service-specific values to.	required

`meth`log_error

log_error(message: str, exception: Exception) -> None

Logs error message.

Parameters

Name	Type	Description	Default
`message`	`str`	The error message.	required
`exception`	`Exception`	The exception that occurred.	required

`meth`log_info

log_info(message: str) -> None

Logs info message.

Parameters

Name	Type	Description	Default
`message`	`str`	The info message.	required

`meth`shutdown

shutdown()

`meth`submit_task

submit_task(task: Callable[[], None]) -> None

Submit the given task

Parameters

Name	Type	Description	Default
`task`	`Callable[[], None]`	The task to be submitted.	required

endstone.metrics.base

classMetricsBase

attrMETRICS_VERSION

attrREPORT_URL

attrenabledabstractmethodproperty

attrservice_enabledabstractmethodproperty

methadd_custom_chart

methappend_platform_data

methappend_service_data

methlog_error

methlog_info

methshutdown

methsubmit_task

On this page

`class`MetricsBase

`attr`METRICS_VERSION

`attr`REPORT_URL

`attr`enabledabstractmethodproperty

`attr`service_enabledabstractmethodproperty

`meth`add_custom_chart

`meth`append_platform_data

`meth`append_service_data

`meth`log_error

`meth`log_info

`meth`shutdown

`meth`submit_task