All engines
This provides guidance on the common engine settings to use the Hive SDK analytics features.
Hive console settings¶
Hive SDK analytics provides various features such as log transmission and cohort analysis. To use Hive SDK analytics, you must first follow the Analytics Console Guide to set up the Hive console.
hive_config.xml configuration¶
This is the hive_config.xml configuration needed when using the analytics feature. Below is an example code assuming all settings are used.
<properties>
<!-- Hive SDK common settings omitted -->
<!-- Hive SDK Analytics Settings: START -->
<maxGameLogSize>50</maxGameLogSize>
<saveAnalyticsLogBeforeCrash>false</saveAnalyticsLogBeforeCrash>
<analyticsSendLimit>5</analyticsSendLimit>
<analyticsQueueLimit>50</analyticsQueueLimit>
<analyticsSendCycle>1</analyticsSendCycle>
<!-- Hive SDK Analytics Settings: END -->
</properties>
Maxgamelogsize¶
The maximum number of game logs stored as unstructured data files. The default value is 50
, and if this value is not defined in hive_config.xml, it will operate with the default value. Do not change this value unless in special circumstances (such as confirming that log collection is not normal due to frequent network delays or disconnections). This value is collected by the Hive Analytics server and can also be changed at runtime using the Configuration class.
Info
To check the collected values, please refer to the following.
Saveanalyticslogbeforecrash (ios)¶
This is to detect the situation just before the app crashes and whether to save the analytics logs that are waiting to be sent to the server as a file. If using an external third-party crash reporter, you should enter false
to disable it to prevent crashes. The default value is false
, and if this value is not defined in hive_config.xml, it will operate with the default value.
Analyticssendlimit¶
The maximum amount of analytics logs to be sent per transmission cycle for Analytics Logs. The default value is 5
, and if this value is not defined in hive_config.xml, it will operate with the default value. It can also be changed at runtime using the Configuration class.
Info
Hive SDK analytics attaches game logs to the analytics logs and sends them together. Developers can check the analytics logs to see the unstructured data sent from the game.
Analyticsqueuelimit¶
Hive is the maximum amount of analytics logs that can be stored in the analytics server. It collects log data (text) structures in the queue and transmits them. The default value is 50
, which means that it transmits 50 log data structures at a time. If this value is not defined in hive_config.xml, it operates with the default value. It can also be changed at runtime through the Configuration class.
Analyticssendcycle¶
This is the transmission cycle of the analytics log. It can be set in seconds, and the analytics log will be sent at the configured interval. The default value is 1
second, and if this value is not defined in hive_config.xml, it will operate with the default value. It can also be changed at runtime through the Configuration class.