Log definition is a function for transferring game logs to Hive Analytics v2.

  • Define the logs that you want to transfer in the game from the backoffice. The designated log will be collected once you apply the created source code on the game after defining the log
  • A feature where you can check whether the log has been defined correctly or not and whether the log is being collected properly or not will be provided in the backoffice.
  • Backoffice route: Analytics > Log Definition

 

Defining a Log

Log Definition List

  1. You can define a new log in the log definition list and also check the log status of the previously defined logs.
  2. Create Client Source: Generate a client source code to apply to the game corresponding to the entire log list that you defined.
  3. Log Definition: Define a new log.
  4. Load to define a new log: You can use this feature after selecting one of the logs that you defined previously and you’ll be moved to the screen where you copy and define the designated log definition details.
  5. Register as template: You can select logs that are frequently used among previously defined logs and register them as a template. Registered templates can be loaded in the log definition screen and used.
  6. Connect to BigQuery: It means that the log data storage has been created correctly.
  7. Exists in the data flow: For newly defined logs, it’ll be shown as “x”. You must check if it’s changed to “O” on the following morning before using it. However, you can collect logs on the day you defined a new log. If you see “X” on the day other than the day that you’ve defined the log, please contact the following.
  8. If there’s “X” displayed for “Connect to BigQuery“ and “Exists in the data flow”, that means that there’s a problem in syncing the data and you must contact the Data Technology Team (DW Part).

Defining a Log with Web Form

  1. Basic Information

    • Table Name: Enter the table name of the corresponding log.
    • Details: Enter details of the corresponding table. This will be exposed in the game information field of the segment, so it is highly recommended that you enter descriptions that users can easily understand. (Ex: Level – User’s account level)
    • Create field via template: If you select one of the previous registered templates, the defined info of the corresponding log will be exposed and you can proceed with log definition by modifying parts that requires modification.
  2. Common Field Settings

    • Common Field is a predefined field where fields that can be used for all logs are defined early ahead.
    • If you check the Select Data Checkbox, the field will become the field used in this log. You’ll still be able to collect logs even if you don’t check as long as it’s transferred in the game. However, you’ll be able to use it more conveniently since a server source code will be created automatically if you check. It’ll be collected from Hive SDK 4 even if you don’t check the client.
  3. Definition Field Settings

    • Definition Field is a part where you set up the game log to be transferred. You need to enter the field name, type, description and sample value.
    • Check the checkbox and the field will become a recommended field and defined as a field that can be used for the segment.
    • Tap the Register Button to complete the log definition. The log will be added to the list once you finish with the log definition, and you’ll be able to add or modify fields and check the collected data in the details page.

Defining Logs with Excel

  1. Create Excel File
    • Enter a table according to the following format.
      Table Name First part of the Appid Table Description
      Field Name 1 Field 1 Type Description on Field 1 Sample value for Field 1
      Field Name 2 Field 2 Type Description on Field 2 Sample value for Field 2
    • For instance, you can create a table as below.
    • You can add a sheet to the excel file to define multiple logs. However, you can only define logs for the same app (game). The sheet name can be anything.
  1. Upload Excel File
    • Click “Define as Excel File” on the log definition list to move to the page shown as below.
    • Drag the excel file created in #1 to the square box and click “Register”.

Managing a Log

Defined Log Detail Page

  • Click on the log and move to the detail page to add a field to the corresponding log from the log definition list or whether to check the log transfer status is correct or not.
  1. Basic Information, Big Query Schema Information

    • Basic Information: You can check the game with defined logs, category, date of registration and details. You can also change the details.
    • Big Query Schema Information: You can view the schema information saved to the Big Query.
  2. Log Field Information

    • Common Fields will be shown in black while fields added from the game will be shown in blue.
    • You can modify the field details and “Use” category.
    • Use: You can select the use of the corresponding field. It will be used as a reference for the person defining the log and it should be applied correctly according to the use when developing the log transmission. Fields set as “Recommended” and “Required” can be used in the segment.
      • Required: Refers to the field that must to be collected. You must include the value of the corresponding field to the game. (Ex: Vid field)
      • Recommended: Refers to the field that’s highly important. It’s a field that’s highly recommended to collect. You can add “Recommended” and “Required” fields as a condition for the segment.
      • Auto: Refers to the field that’s required for the log collection system and it’s generated automatically. (Ex: A field that collects the country value via the client IP with the geoIpCountry field.)
      • Select: Refers to the field that’s collected but optional to use. You don’t have to send this field when transferring the log from the server.
    • Sync with BigQuery: You can check if it’s synced correctly with the Big Query. You’ll see “O” if it’s synced correctly and “X” if there’s an issue with syncing the log. Please contact the Data Technology Team (DW Part) if you see “X”.
    • You can change the order of fields by dragging the Field Info table rows.
  3. Add Field

    • Add Field: It’s a feature where you can add a field to the log that you’ve defined previously. You can add a field in the same way as you did for the log definition.
    • Enter details for the field to add and click on the Run Additional Field Button to save.
  4. ETL Simulation

    • ETL Simulation is a feature where you can check whether the corresponding log definition is being collected correctly or not.
    • Request – Json Body
      • You can check the sample Json of the corresponding log and click on the Send Json Button to check if you get a correct response.
      • Result values will be exposed in the Response Area below when you click on the Send Json Button. Also, the collection status will be shown in stages at the Json data storage server path.
      • Click on the Json data storage server path buttons and the status value will be shown. You’ll be able to check if the data is securely saved by clicking on the Big Query Button and the Json data saved the last will be displayed.
      • Please note that the sample data collected with this feature are actually saved to the DB and there may be a difference due to the log.
  5. Data Sample

    • Data Sample: You can check the log that’s actuallycollected with the corresponding definition. Up to 10 logs will be exposed from the latest to the oldest.
    • Check latest Data waiting to be saved: You can expose the latest log by refreshing.
    • View More: You can view more pages to be able to check more data samples. (Below image)

    • You can check logs of the last 7 days on the data sample view more page and it’s a feature where you can search for fields. You can check all fields by scrolling left and right.
    • Select Field: You can select all fields and search with the selected field’s value.
    • Comparison Method: Supports “=”, which is an equivalent search and “Like” search method.
    • If you want to search for a specific vid’s log, select the vid field, enter the vid and only the corresponding vid’s log will be displayed.
  6. Creating Client Source

    • Create Client Source: Creates a client source of the corresponding log per language.
    • Export Json: Exports the corresponding log to Json. The source will be exported on a new window and you’ll be able to use or modify the exported source.
    • Load to define a new log: Click this button to define a log that’s similar to the corresponding log, and a new log definition screen with logs already defined will be displayed.
    • Delete: Deletes the log definition of the corresponding log.

Send Defined Logs to Server-to-Server

Though Hive Analytics v2 recommends you to transfer the log through the API within Hive SDK v4 as described in “6. Creating Client Source”; you can also send the log to Analytics v2 through server-to-server.

“Fluentd” will be used to send logs. Please refer to the link below on how to use it.

Hive Analytics structure : Fluentd Type
Log Definition Server-to-Server Transmission : Using Fluentd