Up to date

This page is up to date for Godot 4.3. If you still find outdated information, please open an issue.

POGRClient

Inherits: BlaziumClient < Node < Object

Node for connecting to the POGR analytics service.

Description

The POGRClient node provides an interface for connecting to the POGR analytics service. Find out more on the pogr.gg website.

The normal flow is as follows:

1. Initiate a session using init method.

2. Send data using data, event, logs, metrics and monitor methods, depending on use case.

3. Close the session using end method at the end of the game.

Note: All methods are non blocking and can be awaited in order to get the result.

Methods

POGRResponse	data(data: Dictionary)
POGRResponse	end()
POGRResponse	event(event_name: String, event_data: Dictionary, event_flag: String, event_key: String, event_type: String, event_sub_type: String)
String	get_build_id() const
String	get_client_id() const
String	get_pogr_url() const
String	get_session_id()
POGRResponse	init()
POGRResponse	logs(tags: Dictionary, data: Dictionary, environment: String, log: String, service: String, severity: String, type: String)
POGRResponse	metrics(tags: Dictionary, environment: String, metrics: Dictionary, service: String)
POGRResponse	monitor(settings: Dictionary)

---

Method Descriptions

POGRResponse data(data: Dictionary) 🔗

Send unstructured data.

Returns a POGRResponse object that has a POGRResponse.finished signal that is emitted when finished.

---

POGRResponse end() 🔗

Send end request.

Returns a POGRResponse object that has a POGRResponse.finished signal that is emitted when finished.

---

POGRResponse event(event_name: String, event_data: Dictionary, event_flag: String, event_key: String, event_type: String, event_sub_type: String) 🔗

Send event with unstructured data.

Returns a POGRResponse object that has a POGRResponse.finished signal that is emitted when finished.

---

String get_build_id() const 🔗

Get the build id.

---

String get_client_id() const 🔗

Get the client id.

---

String get_pogr_url() const 🔗

Get the pogr url.

---

String get_session_id() 🔗

Get the session id. This is a unique identifier for the current session generated after init is called.

---

POGRResponse init() 🔗

Send init request. Needs to be called first.

Returns a POGRResponse object that has a POGRResponse.finished signal that is emitted when finished.

---

POGRResponse logs(tags: Dictionary, data: Dictionary, environment: String, log: String, service: String, severity: String, type: String) 🔗

Add logs to the analytics.

Returns a POGRResponse object that has a POGRResponse.finished signal that is emitted when finished.

---

POGRResponse metrics(tags: Dictionary, environment: String, metrics: Dictionary, service: String) 🔗

Add metrics to the analytics.

Returns a POGRResponse object that has a POGRResponse.finished signal that is emitted when finished.

---

POGRResponse monitor(settings: Dictionary) 🔗

Send monitor request.

Returns a POGRResponse object that has a POGRResponse.finished signal that is emitted when finished.