{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"2"},"maxLevel":{"value":"2"},"type":{"value":"flat"}},"macroMetadata":{"macroId":{"value":"812af86120b7d64463b747ac09afa7ed"},"schemaVersion":{"value":"1"},"title":"org.randombits.confluence.toc.toc.label"}},"localId":"72c9b4a1-f493-4b84-b268-16358df35c8b"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"Google Workspace allows users to export logs to BigQuery to gain insights into report activity and","type":"text"},{"type":"hardBreak"},{"text":"usage logs.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Devo collector features","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"0ab3b2ef-2f2a-4b04-9967-e08c1200cb68"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[443.0]},"content":[{"type":"paragraph","content":[{"text":"Feature","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[312.0]},"content":[{"type":"paragraph","content":[{"text":"Details","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[443.0]},"content":[{"type":"paragraph","content":[{"text":"Allow parallel downloading (","type":"text"},{"text":"multipod","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[312.0]},"content":[{"type":"paragraph","content":[{"text":"not allowed","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[443.0]},"content":[{"type":"paragraph","content":[{"text":"Running environments","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[312.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"collector server","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"on-premise","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[443.0]},"content":[{"type":"paragraph","content":[{"text":"Populated Devo events","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[312.0]},"content":[{"type":"paragraph","content":[{"text":"table","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[443.0]},"content":[{"type":"paragraph","content":[{"text":"Flattening preprocessing","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[312.0]},"content":[{"type":"paragraph","content":[{"text":"no","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[443.0]},"content":[{"type":"paragraph","content":[{"text":"Allowed source events obfuscation","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[312.0]},"content":[{"type":"paragraph","content":[{"text":"yes","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Data sources","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"9435c4ed-b468-41be-9313-494ec9731a76"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Data source","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[123.0]},"content":[{"type":"paragraph","content":[{"text":"API endpoint","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Collector service name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Devo table","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Activity Records","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"Activity records include activity data for various Google Workspace reports (e.g. \"Accounts\", \"Admin\", \"Gmail\", etc.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[123.0]},"content":[{"type":"paragraph","content":[{"text":"BigQuery search (partition query)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"activity_records","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Various (see service description mapping","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Vendor setup","type":"text"}]},{"type":"paragraph","content":[{"text":"Supported editions for this feature include Frontline Standard, Enterprise Standard and Plus, Education Standard and Plus, and Enterprise Essentials Plus. ","type":"text"},{"text":"Compare your edition","type":"text","marks":[{"type":"link","attrs":{"href":"https://support.google.com/a/answer/6043385"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Set up a BigQuery project for reporting logs - Google Workspace Admin Help","type":"text"}]},{"type":"paragraph","content":[{"text":"Before you set up BigQuery logs in the Google Admin console, establish a BigQuery project for your reporting logs in the Google Cloud console.","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-steps-macro","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"319e4adc-773b-4a35-ace2-790fa0e78514"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step-container.png"}}],"title":"Refined Step Container"}},"localId":"bd8496b1-41e6-4b59-b8ad-6e1668ce2093"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"6cb4084e-2634-4549-b2f9-66dc1a73aa62"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"810a9026-b5d7-44c4-a923-5769d16a37ba"}},{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Google Cloud console","type":"text","marks":[{"type":"link","attrs":{"href":"https://console.cloud.google.com/"}}]},{"text":", create or open an active BigQuery project. For detailed instructions, visit ","type":"text"},{"text":"Creating and managing projects","type":"text","marks":[{"type":"link","attrs":{"href":"https://cloud.google.com/resource-manager/docs/creating-managing-projects"}}]},{"text":".","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Billing must be enabled for each project you create.","type":"text"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"2a55caa6-340c-4274-958a-4bae63eac4b6"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"73c240d5-12d2-4483-8e98-756f865f1b79"}},{"type":"paragraph","content":[{"text":"Go to the ","type":"text"},{"text":"IAM & Admin page","type":"text","marks":[{"type":"link","attrs":{"href":"https://console.cloud.google.com/iam-admin/iam/"}}]},{"text":" for your project.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"95be7219-2156-48ed-9268-a12440645ccc"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"b13039bd-a800-466e-a454-8383c9b16348"}},{"type":"paragraph","content":[{"text":"Add a Google Workspace administrator account as the project editor:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"At the top of the page, click ","type":"text"},{"text":"Add","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In ","type":"text"},{"text":"New members","type":"text","marks":[{"type":"strong"}]},{"text":", enter the project editor's user ID.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In ","type":"text"},{"text":"Select a role","type":"text","marks":[{"type":"strong"}]},{"text":", choose ","type":"text"},{"text":"Project","type":"text","marks":[{"type":"strong"}]},{"text":" then ","type":"text"},{"text":"Editor","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Optionally, to assign the project owner role, click ","type":"text"},{"text":"Add Another Role","type":"text","marks":[{"type":"strong"}]},{"text":" and select ","type":"text"},{"text":"Project","type":"text","marks":[{"type":"strong"}]},{"text":", then ","type":"text"},{"text":"Owner","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Save","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"3e7a38b0-2b38-400e-8b2a-fa4270b7dc4b"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"33dac179-d616-468e-84cd-2e306d09500e"}},{"type":"paragraph","content":[{"text":"Add the ","type":"text"},{"text":"gapps-reports@system.gserviceaccount.com","type":"text","marks":[{"type":"code"}]},{"text":" account as an editor (repeat the steps above).","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Set up BigQuery logs in the Google Admin console","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-steps-macro","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"c8792fd4-42f0-49b6-8124-42d2540ea977"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step-container.png"}}],"title":"Refined Step Container"}},"localId":"1410b8b5-387a-4fdf-8b24-97a09d775dfe"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"f2351a6f-eab4-46eb-8da0-fe660e8ce9fc"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"2a4740e2-bab6-4df9-8e4f-d056edcb850a"}},{"type":"paragraph","content":[{"text":"Sign in to your ","type":"text"},{"text":"Google Admin console","type":"text","marks":[{"type":"link","attrs":{"href":"https://admin.google.com/"}}]},{"text":".","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"adb0742d-15f9-45f9-81bf-7993de3c580f"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"8d2cda01-b4a3-41e5-8f23-c92ca7042551"}},{"type":"paragraph","content":[{"text":"Navigate to ","type":"text"},{"text":"Menu → Reporting → Data integrations","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"171ea8a5-a599-4087-a556-3abccf7b021a"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"6db7535a-ad55-4545-a21a-bc18dd97ad94"}},{"type":"paragraph","content":[{"text":"On the ","type":"text"},{"text":"BigQuery Export","type":"text","marks":[{"type":"strong"}]},{"text":" card, click the pencil icon button (","type":"text"},{"text":"Edit","type":"text","marks":[{"type":"strong"}]},{"text":"). ","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"7504bb99-7b54-47c0-8450-0a8bf52586b1"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"214555c8-4cfa-47a3-82a8-0be783f0e637"}},{"type":"paragraph","content":[{"text":"Enable logs by checking ","type":"text"},{"text":"Enable Google Workspace data export to Google BigQuery","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"2b98ff3f-b614-4f85-b49f-172b1a27da47"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"8920a679-040f-47ef-8e33-9920b0da8a0e"}},{"type":"paragraph","content":[{"text":"Optionally, to export DLP rule logs, check ","type":"text"},{"text":"Allow export of sensitive content from DLP rule logs","type":"text","marks":[{"type":"strong"}]},{"text":". For more information, see ","type":"text"},{"text":"View content that triggers DLP rules","type":"text","marks":[{"type":"link","attrs":{"href":"https://support.google.com/a/answer/14149036"}}]},{"text":".","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"7cc03859-7232-48a6-9194-c2dddd73fb3b"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"c049c7aa-7a80-490b-b947-76321ba3ad3f"}},{"type":"paragraph","content":[{"text":"Select your BigQuery project ID under which to store the logs, ensuring it has write access. See ","type":"text"},{"text":"Quickstart using the Google Cloud console","type":"text","marks":[{"type":"link","attrs":{"href":"https://cloud.google.com/bigquery/docs/quickstarts/quickstart-web-ui"}}]},{"text":" for setup details.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"534e3c9e-e83e-4737-8b29-f919f7d69139"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"b76b79e7-334a-473b-83ba-db98fdfdb154"}},{"type":"paragraph","content":[{"text":"Enter a unique dataset name under ","type":"text"},{"text":"New dataset within project","type":"text","marks":[{"type":"strong"}]},{"text":". For more on dataset creation, visit ","type":"text"},{"text":"Creating datasets","type":"text","marks":[{"type":"link","attrs":{"href":"https://cloud.google.com/bigquery/docs/datasets"}}]},{"text":". Save this dataset name for use in the collector configuration.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"d7735f67-3479-47c5-a8a8-5ca1e0f1ef44"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"22ed478a-6daf-49b9-8df6-c700c2f60b5b"}},{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Save","type":"text","marks":[{"type":"strong"}]},{"text":". If issues arise, consider reconfiguring the dataset in Google Cloud console before saving again.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Logs are written to the dataset the following day, with the necessary service account permissions automatically configured.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Create Google Service Account Credentials for BigQuery Access","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-steps-macro","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"a648bf02-8b80-4a3e-a5de-c73bd4d02566"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step-container.png"}}],"title":"Refined Step Container"}},"localId":"29d3166f-1919-41d9-9c2a-b5401c08710d"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"3faac4c4-5cfb-4798-a833-3d5388a30dc9"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"62b1e0d5-4bd3-4b7b-991f-fb507b18b7c0"}},{"type":"paragraph","content":[{"text":"Access the Google Cloud Console ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"https://console.cloud.google.com/"}}]},{"text":".","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"2f2a69d7-6b9b-40bf-8bdb-72d84ff24c56"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"98cee3d8-ea71-433e-a36b-a87fdc2cb44b"}},{"type":"paragraph","content":[{"text":"Select or create a project. Choose the project associated with your BigQuery setup.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"bca7c46a-ec84-454f-8aa2-dbe8837ad2e3"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"ce6c1fbd-c243-4c94-bdee-f8e9ddb6a539"}},{"type":"paragraph","content":[{"text":"Navigate to","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"IAM & Admin page","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://console.cloud.google.com/iam-admin/iam/"}}]},{"text":" and go to ","type":"text"},{"text":"Service Accounts","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"9f0eed0f-6a55-455b-ba55-00a8426fa228"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"cb1f1a29-8541-481c-91ef-0c84c835d475"}},{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Create Service Account","type":"text","marks":[{"type":"strong"}]},{"text":", enter a name, description, and click ","type":"text"},{"text":"Create","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"d889ee02-3cee-4473-81af-e817fc5d424c"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"f79c7a26-fe67-41a5-894b-2a8949deafe1"}},{"type":"paragraph","content":[{"text":"Assign the service account appropriate roles for BigQuery access (e.g., ","type":"text"},{"text":"BigQuery Admin","type":"text","marks":[{"type":"em"}]},{"text":").","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"727fe369-8f5e-4c20-9155-26e6b025700c"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"Refined Step"}},"localId":"1f1ff0ed-1812-484f-9b9c-e3b5ec8600bf"}},{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Create Key","type":"text","marks":[{"type":"strong"}]},{"text":", choose the key type (JSON recommended), and click ","type":"text"},{"text":"Create","type":"text","marks":[{"type":"strong"}]},{"text":". Download the key file. Save this key file JSON info for use in the collector configuration.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Minimum configuration required for basic pulling","type":"text"}]},{"type":"paragraph","content":[{"text":"Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.","type":"text"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c367918c-a9ae-4aa7-a39b-13c962a20ba0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[261.0]},"content":[{"type":"paragraph","content":[{"text":"Setting","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[498.0]},"content":[{"type":"paragraph","content":[{"text":"Details","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[261.0]},"content":[{"type":"paragraph","content":[{"text":"service_account_info","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[498.0]},"content":[{"type":"paragraph","content":[{"text":"The GCP service account (with BigQuery read/query access) credentials info","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Accepted authentication methods","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"8888800c-9908-4d5e-824f-5c3a255cb3bb"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[277.0]},"content":[{"type":"paragraph","content":[{"text":"Authentication method","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Customer ID","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"Client ID","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[159.0]},"content":[{"type":"paragraph","content":[{"text":"Client secret","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[277.0]},"content":[{"type":"paragraph","content":[{"text":"Service Account Credentials","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"REQUIRED","localId":"e026ceb9-0788-4b7d-a6a8-27d912711589"}},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"REQUIRED","localId":"4d390413-df26-44d2-b34d-ea0ef0eef132"}}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[159.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"REQUIRED","localId":"83e355ac-389e-4f17-9746-11ce9adc7272"}}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Run the collector","type":"text"}]},{"type":"paragraph","content":[{"text":"Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (","type":"text"},{"text":"Cloud collector","type":"text","marks":[{"type":"underline"}]},{"text":"), or deploy and host the collector in your own machine using a Docker image (","type":"text"},{"text":"On-premise collector","type":"text","marks":[{"type":"underline"}]},{"text":").","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-tabs-macro","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"6a805bc0-abf6-4d98-987c-6a9164c77642"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/tab-container.png"}}],"title":"Refined Tab Container"}},"localId":"51a38310-b288-4fb7-a20e-43dcd020e55a"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-tab","parameters":{"macroParams":{"title":{"value":"Cloud collector"}},"macroMetadata":{"macroId":{"value":"2825992cb366f7c43cdf1373692654dc"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"Refined Tab"}},"localId":"58378b2b-93df-42a9-b58b-55dc6b9ec052"}},{"type":"paragraph","content":[{"text":"We use a piece of software called Collector Server to host and manage all our available collectors.","type":"text"}]},{"type":"paragraph","content":[{"text":"To enable the collector for a customer:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Collector Server","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"GUI","type":"text","marks":[{"type":"strong"}]},{"text":", access the ","type":"text"},{"text":"domain","type":"text","marks":[{"type":"strong"}]},{"text":" in which you want this instance to be created","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Add Collector","type":"text","marks":[{"type":"strong"}]},{"text":" and find the one you wish to add.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Version","type":"text","marks":[{"type":"strong"}]},{"text":" field, select the latest value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Collector Name","type":"text","marks":[{"type":"strong"}]},{"text":" field, set the value you prefer (this name must be unique inside the same Collector Server domain).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the sending method select ","type":"text"},{"text":"Direct Send. Direct Send","type":"text","marks":[{"type":"strong"}]},{"text":" configuration is optional for collectors that create ","type":"text"},{"text":"Table","type":"text","marks":[{"type":"code"}]},{"text":" events, but mandatory for those that create ","type":"text"},{"text":"Lookups","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Parameters","type":"text","marks":[{"type":"strong"}]},{"text":" section, establish the ","type":"text"},{"text":"Collector Parameters","type":"text","marks":[{"type":"strong"}]},{"text":" as follows below:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"{\n \"global_overrides\": {\n \"debug\": false\n },\n \"inputs\": {\n \"google_workspace_logs_in_bigquery\": {\n \"id\": \"\",\n \"enabled\": true,\n \"credentials\": {\n \"service_account_info\": \"\"\n },\n \"dataset_id\": \"\",\n \"environment\": \"\",\n \"services\": {\n \"activity_records\": {\n \"request_period_in_seconds\": \"\",\n \"start_time_in_utc\": \"\",\n \"include_record_types\": \"\",\n \"exclude_record_types\": \"\",\n \"override_tag\": \"\",\n \"override_table_id\": \"\"\n }\n }\n }\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"The following table outlines the parameters available for configuring the collector. Each parameter is categorized by its necessity (mandatory or optional), data type, acceptable values or formats, and a brief description.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"ea1b794c-a14e-4d60-97bc-b76c9016aabd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"Data type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Requirement","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"Value range / Format","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"short_unique_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1, Max length: 5","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"Short, unique ID for input service, used in persistence addressing. Avoid duplicates to prevent collisions.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"service_account_info","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"json","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"The service account credential info. This is a JSON block downloadable from Google upon creating a service account credential. The service account must have read access to the BigQuery dataset that stores the activity records.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"environment_value","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"Differentiates environments (e.g., dev, prod). Remove if unused.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"dataset_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"The BigQuery dataset ID that contains the activity data.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"request_period_in_seconds_value","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"int","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"Min: 60","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"Custom period in seconds between data pulls, overriding default (300s).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"start_time_in_utc_value","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"UTC datetime format: ","type":"text"},{"text":"%Y-%m-%dT%H-%M-%SZ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"Custom start date for data retrieval, for historical data download. Remove if unused.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"include_record_types","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"list","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"List of strings. E.g. ","type":"text"},{"text":"[\"gmail\", \"login\"]","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"If specified, the service will fetch ","type":"text"},{"text":"only","type":"text","marks":[{"type":"em"}]},{"text":" those record types defined in the list. The record types are present in the ","type":"text"},{"text":"record_type","type":"text","marks":[{"type":"code"}]},{"text":" field in the BigQuery table.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"exclude_record_types","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"list","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"List of strings. E.g. ","type":"text"},{"text":"[\"gmail\", \"login\"]","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"If specified, the service will exclude the record types defined in the list. The record types are present in the ","type":"text"},{"text":"record_type","type":"text","marks":[{"type":"code"}]},{"text":" field in the BigQuery table.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"override_tag","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"An optional tag to override the default tag for the Devo table.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"override_table_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[217.0]},"content":[{"type":"paragraph","content":[{"text":"An optional override to support users whose activity data is stored in a table other than ","type":"text"},{"text":"activity","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Parameters marked as \"Mandatory\" are required for the collector's configuration. Optional parameters can be omitted or removed if not used, but they provide additional customization and control over the collector's behavior.","type":"text"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-tab","parameters":{"macroParams":{"title":{"value":"On-premise collector"}},"macroMetadata":{"macroId":{"value":"0e08d10a084320745cfcad174c481cfb"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"Refined Tab"}},"localId":"3392ad6b-e017-4587-96ac-e5e9d4459cb2"}},{"type":"paragraph","content":[{"text":"This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Structure","type":"text"}]},{"type":"paragraph","content":[{"text":"The following directory structure should be created for being used when running the collector:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n└── devo-collectors/\n └── /\n ├── certs/\n │ ├── chain.crt\n │ ├── .key\n │ └── .crt\n ├── state/\n └── config/ \n └── config.yaml ","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the proper value.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Devo credentials","type":"text"}]},{"type":"paragraph","content":[{"text":"In Devo, go to ","type":"text"},{"text":"Administration → Credentials → X.509 Certificates","type":"text","marks":[{"type":"strong"}]},{"text":", download the ","type":"text"},{"text":"Certificate","type":"text","marks":[{"type":"strong"}]},{"text":", ","type":"text"},{"text":"Private key","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"Chain CA","type":"text","marks":[{"type":"strong"}]},{"text":" and save them in ","type":"text"},{"text":"/certs/","type":"text","marks":[{"type":"code"}]},{"text":". Learn more about security credentials in Devo ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]},{"text":".","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":754,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":950,"alt":"image-20240624-105853.png","id":"412ef203-ba47-45bd-a101-40acda58518a","collection":"contentId-650018852","type":"file","height":448}}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the proper value.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Editing the config.yaml file","type":"text"}]},{"type":"codeBlock","content":[{"text":"globals:\n debug: false\n id: \n name: \n persistence:\n type: filesystem\n config:\n directory_name: state\noutputs:\n devo_us_1:\n type: devo_platform\n config:\n address: \n port: 443\n type: SSL\n chain: \n cert: \n key: \ninputs:\n google_workspace_logs_in_bigquery:\n id: \n enabled: true\n credentials:\n service_account_info: \n dataset_id: \n environment: \n services:\n activity_records:\n request_period_in_seconds: \n start_time_in_utc: \n include_record_types: \n exclude_record_types: \n override_tag: \n override_table_id: ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the ","type":"text"},{"text":"services","type":"text","marks":[{"type":"code"}]},{"text":" object.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Replace the placeholders with your required values following the description table below: ","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"25575029-391b-4b2b-9438-cfaaad23bf05"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"Data type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Requirement","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Value range / Format","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"short_unique_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1, Max length: 5","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"Short, unique ID for input service, used in persistence addressing. Avoid duplicates to prevent collisions.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"service_account_info","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"json","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"The service account credential info. This is a JSON block downloadable from Google upon creating a service account credential. The service account must have read access to the BigQuery dataset that stores the activity records.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"environment_value","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"Differentiates environments (e.g., dev, prod). Remove if unused.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"dataset_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"The BigQuery dataset ID that contains the activity data.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"request_period_in_seconds_value","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"int","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Min: 60","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"Custom period in seconds between data pulls, overriding default (300s).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"start_time_in_utc_value","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"UTC datetime format: ","type":"text"},{"text":"%Y-%m-%dT%H-%M-%SZ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"Custom start date for data retrieval, for historical data download. Remove if unused.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"include_record_types","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"list","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"List of strings. E.g. ","type":"text"},{"text":"[\"gmail\", \"login\"]","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"If specified, the service will fetch ","type":"text"},{"text":"only","type":"text","marks":[{"type":"em"}]},{"text":" those record types defined in the list. The record types are present in the ","type":"text"},{"text":"record_type","type":"text","marks":[{"type":"code"}]},{"text":" field in the BigQuery table.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"exclude_record_types","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"list","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"List of strings. E.g. ","type":"text"},{"text":"[\"gmail\", \"login\"]","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"If specified, the service will exclude the record types defined in the list. The record types are present in the ","type":"text"},{"text":"record_type","type":"text","marks":[{"type":"code"}]},{"text":" field in the BigQuery table.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"override_tag","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"An optional tag to override the default tag for the Devo table.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"override_table_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Min length: 1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"An optional override to support users whose activity data is stored in a table other than ","type":"text"},{"text":"activity","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Parameters marked as \"Mandatory\" are required for the collector's configuration. Optional parameters can be omitted or removed if not used, but they provide additional customization and control over the collector's behavior.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Download the Docker image","type":"text"}]},{"type":"paragraph","content":[{"text":"The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"94785be3-54fc-4266-9d73-deee265f1451"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[371.0]},"content":[{"type":"paragraph","content":[{"text":"Collector Docker image","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[355.0]},"content":[{"type":"paragraph","content":[{"text":"SHA-256 hash","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[371.0]},"content":[{"type":"paragraph","content":[{"text":"collector-google_workspace_logs_in_bigquery-docker-image-1.0.0","type":"text","marks":[{"type":"link","attrs":{"href":"https://drive.google.com/file/d/1sud9dchWpXv4lxkn2osfJOm8vftqfC2k/view?usp=drive_link"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[355.0]},"content":[{"type":"paragraph","content":[{"text":"37f402945ba2fbb8385d9a8c010e676802a0b55687b21eed5753e9ffc7dce9e3","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Use the following command to add the Docker image to the system:","type":"text"}]},{"type":"codeBlock","content":[{"text":"gunzip -c -.tgz | docker load","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with a proper value.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The Docker image can be deployed on the following services:","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Docker","type":"text"}]},{"type":"paragraph","content":[{"text":"Execute the following command on the root directory ","type":"text"},{"text":"/devo-collectors//","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","content":[{"text":"docker run \n--name collector- \n--volume $PWD/certs:/devo-collector/certs \n--volume $PWD/config:/devo-collector/config \n--volume $PWD/state:/devo-collector/state \n--env CONFIG_FILE=config.yaml \n--rm \n--interactive \n--tty \n:","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the proper values.","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Docker Compose","type":"text"}]},{"type":"paragraph","content":[{"text":"The following Docker Compose file can be used to execute the Docker container. It must be created in the ","type":"text"},{"text":"/devo-collectors//","type":"text","marks":[{"type":"code"}]},{"text":" directory.","type":"text"}]},{"type":"codeBlock","content":[{"text":"version: '3'\nservices:\n collector-:\n image: :${IMAGE_VERSION:-latest}\n container_name: collector-\n volumes:\n - ./certs:/devo-collector/certs\n - ./config:/devo-collector/config\n - ./credentials:/devo-collector/credentials\n - ./state:/devo-collector/state\n environment:\n - CONFIG_FILE=${CONFIG_FILE:-config.yaml}","type":"text"}]},{"type":"paragraph","content":[{"text":"To run the container using docker-compose, execute the following command from the ","type":"text"},{"text":"/devo-collectors//","type":"text","marks":[{"type":"code"}]},{"text":" directory:","type":"text"}]},{"type":"codeBlock","content":[{"text":"IMAGE_VERSION= docker-compose up -d","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the proper values.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Collector services detail","type":"text"}]},{"type":"paragraph","content":[{"text":"This section is intended to explain how to proceed with specific actions for services.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Activity records (","type":"text"},{"text":"activity_records","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Internal process and deduplication method","type":"text"}]},{"type":"paragraph","content":[{"text":"All activity records are fetched continually based on the ","type":"text"},{"text":"time_usec","type":"text","marks":[{"type":"code"}]},{"text":" date time key via BigQuery queries. The collector utilizes the partitions to perform efficient queries. The collector stores the last ","type":"text"},{"text":"time_usec","type":"text","marks":[{"type":"code"}]},{"text":" value and the associated record IDs to ensure that no duplicate records are ingested into the Devo table.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Devo categorization and destination","type":"text"}]},{"type":"paragraph","content":[{"text":"Events are sent to Devo based on the ","type":"text"},{"text":"record_type","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"gmail","type":"text","marks":[{"type":"code"}]},{"text":" record type events are sent to the ","type":"text"},{"text":"cloud.gcp.bigquery.gmail","type":"text","marks":[{"type":"code"}]},{"text":" table","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"All other record types are sent to ","type":"text"},{"text":"my.app.gsuite_activity.{record_type}","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Setup output","type":"text"}]},{"type":"codeBlock","content":[{"text":"2024-05-10T00:49:40.248 INFO InputProcess::MainThread -> BigQueryPullerSetup(unknown,google_workspace_logs_in_bigquery#100000,activity_records#predefined) -> Starting thread\n2024-05-10T00:49:40.249 INFO InputProcess::BigQueryPullerSetup(unknown,google_workspace_logs_in_bigquery#100000,activity_records#predefined) -> Using service account info to authenticate\n2024-05-10T00:49:40.262 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread\n2024-05-10T00:49:40.654 INFO InputProcess::BigQueryPullerSetup(unknown,google_workspace_logs_in_bigquery#100000,activity_records#predefined) -> Setup for module has been successfully executed","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Puller output","type":"text"}]},{"type":"codeBlock","content":[{"text":"2024-05-10T00:49:41.324 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) Starting the execution of pre_pull()\n2024-05-10T00:49:41.326 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Reading persisted data\n2024-05-10T00:49:41.328 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Data retrieved from the persistence: {'@persistence_version': 1, 'start_time_in_utc': '2024-04-20T00:00:00.000000Z', 'last_event_time_in_utc': '2024-04-22T08:20:00.000000Z', 'last_ids': ['1991b279fb251ee850b64cc04f722b914b6504563a3dad18f40c09c4d1f8c0e5']}\n2024-05-10T00:49:41.330 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Running the persistence upgrade steps\n2024-05-10T00:49:41.331 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Running the persistence corrections steps\n2024-05-10T00:49:41.331 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Running the persistence corrections steps\n2024-05-10T00:49:41.333 WARNING InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: {'@persistence_version': 1, 'start_time_in_utc': '2024-04-20T00:00:00.000000Z', 'last_event_time_in_utc': '2024-04-22T08:20:00.000000Z', 'last_ids': ['1991b279fb251ee850b64cc04f722b914b6504563a3dad18f40c09c4d1f8c0e5']}. New content: {'@persistence_version': 1, 'start_time_in_utc': None, 'last_event_time_in_utc': '2024-05-10T04:49:36.324054Z', 'last_ids': []}\n2024-05-10T00:49:41.338 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Updating the persistence\n2024-05-10T00:49:41.340 WARNING InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Persistence has been updated successfully\n2024-05-10T00:49:41.340 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) Finalizing the execution of pre_pull()\n2024-05-10T00:49:41.340 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Starting data collection every 300 seconds\n2024-05-10T00:49:41.341 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Pull Started\n2024-05-10T00:49:41.342 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Fetching records via fetch_activity_data occurring between 2024-05-10T04:49:36.324054Z and 2024-05-10T04:49:36.324054Z\n2024-05-10T00:49:43.406 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Pull completed up to the current time.\n2024-05-10T00:49:43.410 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Updating the persistence\n2024-05-10T00:49:43.411 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1715316581324):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.\n2024-05-10T00:49:43.411 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1715316581324):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.\n2024-05-10T00:49:43.411 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> The data is up to date!\n2024-05-10T00:49:43.411 INFO InputProcess::BigQueryPuller(google_workspace_logs_in_bigquery,100000,activity_records,predefined) -> Data collection completed. Elapsed time: 2.087 seconds. Waiting for 297.913 second(s) until the next one","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Restart the persistence","type":"text"}]},{"type":"paragraph","content":[{"text":"This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. In case you want to re-ingest historical data or recreate the persistence, you can restart the persistence of this collector by following these steps:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Edit the configuration file.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Change the value of the ","type":"text"},{"text":"start_time_in_utc parameter","type":"text","marks":[{"type":"code"}]},{"text":" to a different one.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Save the changes.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Restart the collector.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The collector will detect this change and will restart the persistence using the parameters of the configuration file or the default configuration in case it has not been provided.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Troubleshooting ]","type":"text"}]},{"type":"paragraph","content":[{"text":"This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7fa7d0bd-ae05-407d-a7ef-f9cf512849d1"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Error type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"Error ID","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"Error message","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"Cause","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Solution","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariablesError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"Invalid ","type":"text"},{"text":"start_time_in_utc: {ini_start_str}","type":"text","marks":[{"type":"code"}]},{"text":". Must be in parseable datetime format.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"The configured ","type":"text"},{"text":"start_time_in_utc","type":"text","marks":[{"type":"code"}]},{"text":" parameter is a non-parseable format.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Update the ","type":"text"},{"text":"start_time_in_utc","type":"text","marks":[{"type":"code"}]},{"text":" value to have the recommended format as indicated in the guide.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariablesError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"Invalid ","type":"text"},{"text":"start_time_in_utc: {ini_start_str}","type":"text","marks":[{"type":"code"}]},{"text":". Must be in the past.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"The configured ","type":"text"},{"text":"start_time_in_utc","type":"text","marks":[{"type":"code"}]},{"text":" parameter is a future date.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Update the ","type":"text"},{"text":"start_time_in_utc","type":"text","marks":[{"type":"code"}]},{"text":" value to a past datetime.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"ApiError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"An error occurred while trying to authenticate with the Azure API. Exception: {e}","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"The collector is unable to authenticate with the Azure API.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Check the credentials and ensure that the collector has the necessary permissions to access the Azure API.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"ApiError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"410","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"An error occurred while trying to check if container ","type":"text"},{"text":"{container_name}","type":"text","marks":[{"type":"code"}]},{"text":" exists. Ensure that the blob storage account name or connection string is correct. Exception: ","type":"text"},{"text":"{e}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"The collector was unable to locate the specified blob storage container name.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Ensure the container exists and the credentials have READ access to the container","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"ApiError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"411","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"An error occurred while trying to check if container ","type":"text"},{"text":"{container_name}","type":"text","marks":[{"type":"code"}]},{"text":" exists. Ensure that the application has necessary permissions to access the containers. Exception: ","type":"text"},{"text":"{e}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"The collector was unable to access the specified blob storage container name.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Ensure the container exists and the credentials have READ access to the container","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"ApiError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"412","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"An error occurred while trying to create container ","type":"text"},{"text":"{container_name}","type":"text","marks":[{"type":"code"}]},{"text":". Ensure that the application has necessary permissions to create containers. Exception: ","type":"text"},{"text":"{e}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"The collector was unable to create the container for the auto discover service and the user indicated to use Azure Blob Storage checkpointing.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Ensure the credentials have WRITE access to the container storage account.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"ApiError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"420","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"An error occurred while trying to get consumer group ","type":"text"},{"text":"{consumer_group_name}","type":"text","marks":[{"type":"code"}]},{"text":". Exception: ","type":"text"},{"text":"{e}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"The collector was unable to access the specified consumer group name.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Ensure the consumer group exists and the credentials have READ access to the consumer group","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"ApiError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"421","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"An error occurred while trying to create consumer group ","type":"text"},{"text":"{consumer_group_name}","type":"text","marks":[{"type":"code"}]},{"text":". Ensure that the application has necessary permissions to create consumer groups. Exception: ","type":"text"},{"text":"{e}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"The collector was unable to create the consumer group for the auto discover service.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Ensure the credentials have WRITE access to the event hub namespace or use the ","type":"text"},{"text":"$Default","type":"text","marks":[{"type":"code"}]},{"text":" consumer group.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":" Collector operations","type":"text"}]},{"type":"paragraph","content":[{"text":"This section is intended to explain how to proceed with specific operations of this collector.","type":"text"}]},{"type":"expand","attrs":{"title":"Verify collector operations"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Initialization","type":"text"}]},{"type":"paragraph","content":[{"text":"The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration.","type":"text"}]},{"type":"paragraph","content":[{"text":"A successful run has the following output messages for the initializer module:","type":"text"}]},{"type":"codeBlock","content":[{"text":"2023-01-10T15:22:57.146 INFO MainProcess::MainThread -> Loading configuration using the following files: {\"full_config\": \"config-test-local.yaml\", \"job_config_loc\": null, \"collector_config_loc\": null}\n2023-01-10T15:22:57.146 INFO MainProcess::MainThread -> Using the default location for \"job_config_loc\" file: \"/etc/devo/job/job_config.json\"\n2023-01-10T15:22:57.147 INFO MainProcess::MainThread -> \"\\etc\\devo\\job\" does not exists\n2023-01-10T15:22:57.147 INFO MainProcess::MainThread -> Using the default location for \"collector_config_loc\" file: \"/etc/devo/collector/collector_config.json\"\n2023-01-10T15:22:57.148 INFO MainProcess::MainThread -> \"\\etc\\devo\\collector\" does not exists\n2023-01-10T15:22:57.148 INFO MainProcess::MainThread -> Results of validation of config files parameters: {\"config\": \"C:\\git\\collectors2\\devo-collector-\\config\\config.yaml\", \"config_validated\": True, \"job_config_loc\": \"/etc/devo/job/job_config.json\", \"job_config_loc_default\": True, \"job_config_loc_validated\": False, \"collector_config_loc\": \"/etc/devo/collector/collector_config.json\", \"collector_config_loc_default\": True, \"collector_config_loc_validated\": False}\n2023-01-10T15:22:57.171 WARNING MainProcess::MainThread -> [WARNING] Illegal global setting has been ignored -> multiprocessing: False","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Events delivery and Devo ingestion","type":"text"}]},{"type":"paragraph","content":[{"text":"The event delivery module is in charge of receiving the events from the internal queues where all events are injected by the pullers and delivering them using the selected compatible delivery method.","type":"text"}]},{"type":"paragraph","content":[{"text":"A successful run has the following output messages for the initializer module:","type":"text"}]},{"type":"codeBlock","content":[{"text":"2023-01-10T15:23:00.788 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread\n2023-01-10T15:23:00.789 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)\n2023-01-10T15:23:00.790 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread\n2023-01-10T15:23:00.842 INFO OutputProcess::MainThread -> global_status: {\"output_process\": {\"process_id\": 18804, \"process_status\": \"running\", \"thread_counter\": 21, \"thread_names\": [\"MainThread\", \"pydevd.Writer\", \"pydevd.Reader\", \"pydevd.CommandThread\", \"pydevd.CheckAliveThread\", \"DevoSender(standard_senders,devo_sender_0)\", \"DevoSenderManagerMonitor(standard_senders,devo_1)\", \"DevoSenderManager(standard_senders,manager,devo_1)\", \"OutputStandardConsumer(standard_senders_consumer_0)\",","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"By default, these information traces will be displayed every 10 minutes.","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Sender services","type":"text"}]},{"type":"paragraph","content":[{"text":"The Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (","type":"text"},{"text":"internal","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"standard","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"lookup","type":"text","marks":[{"type":"code"}]},{"text":"). This collector uses the following Sender Services:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"6bd704ef-0e1e-4407-992c-002264d15132"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[231.0]},"content":[{"type":"paragraph","content":[{"text":"Sender services","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[499.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[231.0]},"content":[{"type":"paragraph","content":[{"text":"internal_senders","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[499.0]},"content":[{"type":"paragraph","content":[{"text":"In charge of delivering internal metrics to Devo such as logging traces or metrics.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[231.0]},"content":[{"type":"paragraph","content":[{"text":"standard_senders","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[499.0]},"content":[{"type":"paragraph","content":[{"text":"In charge of delivering pulled events to Devo.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Sender statistics","type":"text"}]},{"type":"paragraph","content":[{"text":"Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"b4ce6589-85aa-4583-b31b-545216de40ff"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[285.0]},"content":[{"type":"paragraph","content":[{"text":"Logging trace","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[445.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[285.0]},"content":[{"type":"paragraph","content":[{"text":"Number of available senders: 1","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[445.0]},"content":[{"type":"paragraph","content":[{"text":"Displays the number of concurrent senders available for the given Sender Service.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[285.0]},"content":[{"type":"paragraph","content":[{"text":"sender manager internal queue size: 0","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[445.0]},"content":[{"type":"paragraph","content":[{"text":"Displays the items available in the internal sender queue.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This value helps detect bottlenecks and needs to increase the performance of data delivery to Devo. This last can be made by increasing the concurrent senders.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[285.0]},"content":[{"type":"paragraph","content":[{"text":"Total number of messages sent: 44, messages sent since \"2022-06-28 10:39:22.511671+00:00\": 21 (elapsed 0.007 seconds)","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[445.0]},"content":[{"type":"paragraph","content":[{"text":"Displays the number of events from the last time and following the given example, the following conclusions can be obtained:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"44 events were sent to Devo since the collector started.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The last checkpoint timestamp was ","type":"text"},{"text":"2022-06-28 10:39:22.511671+00:00","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"21 events where sent to Devo between the last UTC checkpoint and now.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Those 21 events required ","type":"text"},{"text":"0.007 seconds","type":"text","marks":[{"type":"code"}]},{"text":" to be delivered.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"By default these traces will be shown every 10 minutes.","type":"text"}]}]}]}]}]}]},{"type":"expand","attrs":{"title":"Check memory usage"},"content":[{"type":"paragraph","content":[{"text":"To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The global pressure of the available memory is displayed in the ","type":"text"},{"text":"global","type":"text","marks":[{"type":"code"}]},{"text":" value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"All metrics (Global, RSS, VMS) include the value before freeing and after ","type":"text"},{"text":"previous -> after freeing memory","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"codeBlock","content":[{"text":" INFO InputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(34.50MiB -> 34.08MiB), VMS(410.52MiB ->\n 410.02MiB)\n INFO OutputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(28.41MiB -> 28.41MiB), VMS(705.28MiB ->\n 705.28MiB)","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Change log","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ffe42a46-4f35-4aec-b7a9-e5bb47d1fad6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"Release","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Released on","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Release type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[157.0]},"content":[{"type":"paragraph","content":[{"text":"Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[154.0]},"content":[{"type":"paragraph","content":[{"text":"Recommendations","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[101.0]},"content":[{"type":"paragraph","content":[{"text":"v1.0.0","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"type":"date","attrs":{"timestamp":"1717632000000"}}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"purple","style":"bold","text":"NEW COLLECTOR","localId":"39240b48-74c1-4766-ba78-09ea1b239815"}},{"text":" ","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[157.0]},"content":[{"type":"paragraph","content":[{"text":"New collector","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[154.0]},"content":[{"type":"paragraph","content":[{"text":"-","type":"text","marks":[{"type":"code"}]}]}]}]}]}],"version":1}

Browser not supported