endstone.metrics

Modules

Name	Description
`base`
`charts`
`config`

Classes

Name	Description
`AdvancedBarChart`
`AdvancedPie`
`CustomChart`	Represents a custom chart.
`DrilldownPie`
`Metrics`
`MultiLineChart`
`SimpleBarChart`
`SimplePie`
`SingleLineChart`

`class`AdvancedBarChart

Bases: CustomChart

AdvancedBarChart(chart_id: str, get_values: Callable[[], Dict[str, List[int]] | None])

Parameters

Name	Type	Description	Default
`chart_id`	`str`	The id of the chart.	required
`get_values`	`Callable[[], Dict[str, List[int]] \| None]`	The callable which is used to request the chart data.	required

Methods

Name	Description
`get_chart_data`	Gets the data for the advanced bar chart.

Attributes

Name	Type	Description
`get_values`

`attr`get_values

get_values

`meth`get_chart_data

get_chart_data() -> dict | None

Gets the data for the advanced bar chart.

Returns

Type	Description
`dict \| None`	dict \| None: A dictionary with the chart data.

`class`AdvancedPie

Bases: CustomChart

AdvancedPie(chart_id: str, get_values: Callable[[], dict[str, int] | None])

Parameters

Name	Type	Description	Default
`chart_id`	`str`	The id of the chart.	required
`get_values`	`Callable[[], dict[str, int] \| None]`	The callable which is used to request the chart data.	required

Methods

Name	Description
`get_chart_data`	Gets the data for the advanced pie chart.

Attributes

Name	Type	Description
`get_values`

`attr`get_values

get_values

`meth`get_chart_data

get_chart_data() -> dict | None

Gets the data for the advanced pie chart.

Returns

Type	Description
`dict \| None`	dict \| None: A dictionary with the chart data.

`class`CustomChart

Bases: ABC

CustomChart(chart_id: str)

Represents a custom chart.

Parameters

Name	Type	Description	Default
`chart_id`	`str`	The id of the chart.	required

Raises

Type	Description
`ValueError`	If chart_id is None or empty.

Methods

Name	Description
`get_chart_data`	Gets the data for the chart.

Attributes

Name	Type	Description
`chart_id`

`attr`chart_id

chart_id

`meth`get_chart_dataabstractmethod

get_chart_data() -> dict | None

Gets the data for the chart.

Returns

Name	Type	Description
`dict`	`dict \| None`	A dictionary with the chart data.

Raises

Type	Description
`Exception`	If there is an error getting the chart data.

`class`DrilldownPie

Bases: CustomChart

DrilldownPie(chart_id: str, get_values: Callable[[], Dict[str, Dict[str, int]] | None])

Parameters

Name	Type	Description	Default
`chart_id`	`str`	The id of the chart.	required
`get_values`	`Callable[[], Dict[str, Dict[str, int]] \| None]`	The callable which is used to request the chart data.	required

Methods

Name	Description
`get_chart_data`	Gets the data for the advanced pie chart.

Attributes

Name	Type	Description
`get_values`

`attr`get_values

get_values

`meth`get_chart_data

get_chart_data() -> dict | None

Gets the data for the advanced pie chart.

Returns

Type	Description
`dict \| None`	dict \| None: A dictionary with the chart data.

`class`Metrics

Bases: MetricsBase

Metrics(plugin: Plugin, service_id: int)

Parameters

Name	Type	Description	Default
`plugin`	`Plugin`	Your plugin instance.	required
`service_id`	`int`	The id of the service. It can be found at https://bstats.org/what-is-my-plugin-id	required

Methods

Name	Description
`append_platform_data`	Appends platform-specific data to the provided dict.
`append_service_data`	Appends service-specific data to the provided dict.
`log_error`
`log_info`
`submit_task`

Attributes

Name	Type	Description
`enabled`	`bool`
`service_enabled`	`bool`

`attr`enabledproperty

enabled: bool

`attr`service_enabledproperty

service_enabled: bool

`meth`append_platform_data

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

Appends platform-specific data to the provided dict.

Parameters

Name	Type	Description	Default
`platform_data`	`Dict[str, Any]`	The dict to append data to.	required

`meth`append_service_data

append_service_data(service_data: Dict[str, Any])

Appends service-specific data to the provided dict.

Parameters

Name	Type	Description	Default
`service_data`	`Dict[str, Any]`	The dict to append data to.	required

`meth`log_error

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

`meth`log_info

log_info(message: str) -> None

`meth`submit_task

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

`class`MultiLineChart

Bases: CustomChart

MultiLineChart(chart_id: str, get_values: Callable[[], Dict[str, int] | None])

Parameters

Name	Type	Description	Default
`chart_id`	`str`	The id of the chart.	required
`get_values`	`Callable[[], Dict[str, int] \| None]`	The callable which is used to request the chart data.	required

Methods

Name	Description
`get_chart_data`	Gets the data for the multi-line chart.

Attributes

Name	Type	Description
`get_values`

`attr`get_values

get_values

`meth`get_chart_data

get_chart_data() -> dict | None

Gets the data for the multi-line chart.

Returns

Type	Description
`dict \| None`	dict \| None: A dictionary with the chart data.

`class`SimpleBarChart

Bases: CustomChart

SimpleBarChart(chart_id: str, get_values: Callable[[], Dict[str, int] | None])

Parameters

Name	Type	Description	Default
`chart_id`	`str`	The id of the chart.	required
`get_values`	`Callable[[], Dict[str, int] \| None]`	The callable which is used to request the chart data.	required

Methods

Name	Description
`get_chart_data`	Gets the data for the simple bar chart.

Attributes

Name	Type	Description
`get_values`

`attr`get_values

get_values

`meth`get_chart_data

get_chart_data() -> dict | None

Gets the data for the simple bar chart.

Returns

Type	Description
`dict \| None`	dict \| None: A dictionary with the chart data.

`class`SimplePie

Bases: CustomChart

SimplePie(chart_id: str, get_value: Callable[[], str | None])

Parameters

Name	Type	Description	Default
`chart_id`	`str`	The id of the chart.	required
`get_value`	`Callable[[], str \| None]`	The callable which is used to request the chart data.	required

Methods

Name	Description
`get_chart_data`	Gets the data for the simple pie chart.

Attributes

Name	Type	Description
`get_value`

`attr`get_value

get_value

`meth`get_chart_data

get_chart_data() -> dict | None

Gets the data for the simple pie chart.

Returns

Type	Description
`dict \| None`	dict \| None: A dictionary with the chart data.

`class`SingleLineChart

Bases: CustomChart

SingleLineChart(chart_id: str, get_value: Callable[[], int])

Parameters

Name	Type	Description	Default
`chart_id`	`str`	The id of the chart.	required
`get_value`	`Callable[[], int]`	The callable which is used to request the chart data.	required

Methods

Name	Description
`get_chart_data`	Gets the data for the simple pie chart.

Attributes

Name	Type	Description
`get_value`

`attr`get_value

get_value

`meth`get_chart_data

get_chart_data() -> dict | None

Gets the data for the simple pie chart.

Returns

Type	Description
`dict \| None`	dict \| None: A dictionary with the chart data.

classAdvancedBarChart

attrget_values

methget_chart_data

classAdvancedPie

attrget_values

methget_chart_data

classCustomChart

attrchart_id

methget_chart_dataabstractmethod

classDrilldownPie

attrget_values

methget_chart_data

classMetrics

attrenabledproperty

attrservice_enabledproperty

methappend_platform_data

methappend_service_data

methlog_error

methlog_info

methsubmit_task

classMultiLineChart

attrget_values

methget_chart_data

classSimpleBarChart

attrget_values

methget_chart_data

classSimplePie

attrget_value

methget_chart_data

classSingleLineChart

attrget_value

methget_chart_data

On this page

`class`AdvancedBarChart

`attr`get_values

`meth`get_chart_data

`class`AdvancedPie

`attr`get_values

`meth`get_chart_data

`class`CustomChart

`attr`chart_id

`meth`get_chart_dataabstractmethod

`class`DrilldownPie

`attr`get_values

`meth`get_chart_data

`class`Metrics

`attr`enabledproperty

`attr`service_enabledproperty

`meth`append_platform_data

`meth`append_service_data

`meth`log_error

`meth`log_info

`meth`submit_task

`class`MultiLineChart

`attr`get_values

`meth`get_chart_data

`class`SimpleBarChart

`attr`get_values

`meth`get_chart_data

`class`SimplePie

`attr`get_value

`meth`get_chart_data

`class`SingleLineChart

`attr`get_value

`meth`get_chart_data