{"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":"5cfd0276c80b9ce43a3742b363374e53"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"2fd2ab0d-83f3-4e1c-bb3f-fb17a278bb87"}},{"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","localId":"c367918c-a9ae-4aa7-a39b-13c962a20ba0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Setting","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Details","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"base_url","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Base URL for SailPoint instance.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"client_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"client_id ","type":"text","marks":[{"type":"code"}]},{"text":"obtained from SailPoint for authentication.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"client_secret","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"client_secret","type":"text","marks":[{"type":"code"}]},{"text":" obtained from SailPoint for authentication","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"See the ","type":"text"},{"text":"Accepted authentication methods","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"#Accepted-authentication-methods"}}]},{"text":" section to verify what settings are required based on the desired authentication method.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"Sailpoint IdentityNow","type":"text","marks":[{"type":"strong"}]},{"text":" is an identity management solution that helps organizations manage employees' permission, digital identities, information security, data access compliance, and more on a unified portal.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Devo collector features","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"0ab3b2ef-2f2a-4b04-9967-e08c1200cb68"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Feature","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Details","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.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":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Allowed","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Running environments","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Collector server","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"On-premise","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Populated Devo events","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Table","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph","content":[{"text":"Flattening preprocessing","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.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","localId":"0d25b3bc-c9a8-4706-a68f-31822c11731e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"Data Source","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"API Endpoint","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"Collector service name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"Devo Table","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"Available from release","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"Account activities","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"Account activities entries","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"/v3/account-activities","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"account_activities","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"iam.sailpoint.identitynow.account_activity","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"v1.0.0","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"Events","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"Event related to management console","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"/v3/search","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"events","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"iam.sailpoint.identitynow.event","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"v1.0.0","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"For more information on how the events are parsed, ","type":"text"},{"text":"visit our page","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/latest/pages/281182295"}}]},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Flattening preprocessing","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"21ee59a7-1cce-4799-a831-abe7f7dc9012"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"Data source","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"Collector service","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"Flattening details","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"Account activities","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"account_activities","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"No","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"Account activities are flattened on the ","type":"text"},{"text":"items","type":"text","marks":[{"type":"code"}]},{"text":" list. ","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Vendor setup","type":"text"}]},{"type":"paragraph","content":[{"text":"There are some requirements to run this collector. In order to retrieve the data, you must configure a ","type":"text"},{"text":"Client_ID","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"Client Secret ","type":"text","marks":[{"type":"code"}]},{"text":"for API access to the ","type":"text"},{"text":"SailPoint IdentityNow Portal","type":"text","marks":[{"type":"strong"}]},{"text":". Follow these steps to obtain an ","type":"text"},{"text":"access token","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-steps-macro","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"b1994660-a46e-41e4-b1d3-c8bc053982ef"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/steps.png"}}],"title":"UI Steps"}},"localId":"d06cc156-2598-4156-9248-9446f7754556"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"96765b19-a3cc-4809-8934-841071dbad65"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"8106da14-44b6-4411-85e4-cb1181d2e0b8"}},{"type":"paragraph","content":[{"text":"Log into the ","type":"text"},{"text":"SailPoint console","type":"text","marks":[{"type":"link","attrs":{"href":"https://id.sailpoint.com/signon/?flowId=005f55bd-aeef-491c-a33e-8cae13a25eb2"}}]},{"text":" using an account with an Administrator role and permissions. ","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"40e01aca-0aa0-4550-99a8-cfdb6357df2a"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"171914e0-3674-4862-aec0-e831561732b6"}},{"type":"paragraph","content":[{"text":"Select ","type":"text"},{"text":"Preferences","type":"text","marks":[{"type":"strong"}]},{"text":" from the drop-down menu under your username, then","type":"text"},{"text":" Personal Access Tokens","type":"text","marks":[{"type":"strong"}]},{"text":" on the left. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"URL","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"You can also use this URL ","type":"text"},{"text":"https://{tenant}.identitynow.com or https://{tenant}.identitynow.com/ui/d/user-preferences/personal-access-tokens","type":"text","marks":[{"type":"code"}]},{"text":". and replace {","type":"text"},{"text":"tenant","type":"text","marks":[{"type":"code"}]},{"text":"} with your IdentityNow tenant.","type":"text"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"9e5276be-50df-46c4-b1b0-a28ffdd384e5"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"96dba0ff-4503-493d-b975-8a111f818764"}},{"type":"paragraph","content":[{"text":"Select ","type":"text"},{"text":"New Token","type":"text","marks":[{"type":"strong"}]},{"text":" and enter a meaningful description to help differentiate the token from others. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Important","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"New Token button","type":"text","marks":[{"type":"strong"}]},{"text":" will be disabled when you have reached the limit of 10 personal access tokens per user. To avoid reaching this limit, it is recommended you delete any tokens that are no longer needed.","type":"text"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"8a3eb97f-56a1-479c-92cb-6a9da1a06010"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"444fe4ae-3be1-4247-a8d4-c46b9f030b56"}},{"type":"paragraph","content":[{"text":"Select ","type":"text"},{"text":"New Token","type":"text","marks":[{"type":"strong"}]},{"text":" and enter a meaningful description to help differentiate the token from others. ","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"05e88abb-1925-4125-98fa-1a69304d9da1"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"dc36102d-6719-4a16-b3ec-ae235bf39c7c"}},{"type":"paragraph","content":[{"text":"Select ","type":"text"},{"text":"Create Token","type":"text","marks":[{"type":"strong"}]},{"text":" to generate and view the two components that comprise the token: the ","type":"text"},{"text":"Secret","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"Client_ID","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Important","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"After you create the token, the value of the ","type":"text"},{"text":"Client_ID","type":"text","marks":[{"type":"code"}]},{"text":" will be visible in the ","type":"text"},{"text":"Personal Access Tokens list","type":"text","marks":[{"type":"strong"}]},{"text":", but the corresponding ","type":"text"},{"text":"Secret","type":"text","marks":[{"type":"code"}]},{"text":" will not be visible after you close the window. You will need to store the ","type":"text"},{"text":"Secret","type":"text","marks":[{"type":"code"}]},{"text":" somewhere secure.","type":"text"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"348288df-5204-4760-94ae-336887af8046"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"fe4a2eb1-4033-4fb8-aac4-e0033a1551cb"}},{"type":"paragraph","content":[{"text":"Copy both values somewhere that will be secure and accessible to you when you need to use the token. Select ","type":"text"},{"text":"Save","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Accepted-authentication-methods"}},"macroMetadata":{"macroId":{"value":"8bd2c517f8997300bacfb70f042aa610"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"d35c3833-d09a-4578-951e-d8877c597529"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Accepted authentication methods","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"511ae2fa-97a1-420d-8193-a28b5a980a68"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"Authentication method","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[252.0]},"content":[{"type":"paragraph","content":[{"text":"Client ID","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[252.0]},"content":[{"type":"paragraph","content":[{"text":"Secret","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"OAuth","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[252.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"Required","localId":"6428c794-69e3-47d5-a119-7922bfa27ba9"}},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[252.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"Required","localId":"1fdaee92-11ea-4232-9932-77595b1db7de"}}]}]}]}]},{"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://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tabs.png"}}],"title":"UI Tabs"}},"localId":"63fc21b0-28eb-4655-96ad-83351fded183"},"content":[{"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://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"UI Tab"}},"localId":"60845a41-d22e-474d-a8fa-e31d423b41ef"}},{"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"},"content":[{"type":"media","attrs":{"width":1822,"id":"16e37f1a-faa2-44c7-9030-dfb684bdd9ad","collection":"contentId-313862347","type":"file","height":471}}]},{"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: \n id: \n name: \n persistence:\n type: filesystem\n config:\n directory_name: state\noutputs:\n devo_1:\n type: devo_platform\n config:\n address: \n port: 443\n type: SSL\n chain: \n cert: \n key: \ninputs:\n sailpoint:\n id: \n enabled: \n requests_per_second: \n base_url: \n credentials:\n client_secret: \n client_id: \n services:\n events:\n tag: \n initial_start_time_in_utc: \n account_activities:\n tag: \n initial_start_time_in_utc: ","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":"9d73dbcb-9595-4b0b-a3e8-ff991b7dbeaa"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Data type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Value range / format","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Details","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"debug_status","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"bool","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"true / false","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"If the value is ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the debug logging traces will be enabled when running the collector. If the value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":", only the info, warning, and error logging levels will be printed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"collector_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"int","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"minimum length: ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"maximum length: ","type":"text"},{"text":"5","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Use this parameter to give a unique ID to this collector.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"collector_name","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"minimum length: ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"maximum length: ","type":"text"},{"text":"10","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Use this parameter to give a valid name to this collector.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"devo_address","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"collector-us.devo.io ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"collector-eu.devo.io ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Use this parameter to identify the Devo Cloud where the events will be sent.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"chain_filename","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"minimum length: ","type":"text"},{"text":"4","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"maximum length: ","type":"text"},{"text":"20","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Use this parameter to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: ","type":"text"},{"text":"chain.crt","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"cert_filename","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"minimum length: ","type":"text"},{"text":"4","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"maximum length: ","type":"text"},{"text":"20","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Use this parameter to identify the ","type":"text"},{"text":"file.cert ","type":"text","marks":[{"type":"code"}]},{"text":"downloaded from your Devo domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"key_filename","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"minimum length: ","type":"text"},{"text":"4","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"maximum length: ","type":"text"},{"text":"20","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Use this parameter to identify the ","type":"text"},{"text":"file.key ","type":"text","marks":[{"type":"code"}]},{"text":"downloaded from your Devo domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"input_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"minimum length: ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"maximum length: ","type":"text"},{"text":"20","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Use this parameter to give a unique ID to this input service.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"This parameter is used to build the persistence address; do not use the same value for multiple collectors. It could cause a collision.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"input_status","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"bool","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"true / false","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Use this parameter to enable or disable the given input logic when running the collector. If the value is ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the input will be run. If the value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":", it will be ignored.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"requests_per_second","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"int","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"minimum length: ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Period in seconds used between each data pulling. This value will overwrite the default value (300 seconds).","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This parameter should be removed if it is not used.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"base_url","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"-","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Base URL for SailPoint instance.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"client_secret","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"-","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"client_secret","type":"text","marks":[{"type":"code"}]},{"text":" obtained from SailPoint for authentication.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"client_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"-","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"client_id","type":"text","marks":[{"type":"code"}]},{"text":" obtained from SailPoint for authentication.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"tag","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Devo tag-friendly string (no special characters, spaces, etc.)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"An optional tag that allows users to override the service default tags.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This parameter should be removed if it is not used.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"initial_start_time_in_utc","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"str","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"UTC datetime string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This parameter should be removed if it is not used.","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":[363.0]},"content":[{"type":"paragraph","content":[{"text":"Collector Docker image","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[363.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":[363.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"},{"text":"collector-sailpoint_identitynow_if-docker-image-1.0.0","type":"text","marks":[{"type":"link","attrs":{"href":"https://drive.google.com/file/d/1GjQxgaiQM-v__6i9v_KIJPNRyhp-pM28/view?usp=sharing"}}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[363.0]},"content":[{"type":"paragraph","content":[{"text":"099db0a69be640d16ec01d6524485845e52a5e775e0866a22df70fc124647b1c","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":"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://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"UI Tab"}},"localId":"b1c7a00e-ca44-4c11-bae5-58f8779977d7"}},{"type":"paragraph","content":[{"text":"We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, ","type":"text"},{"text":"get in touch with us","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:support@devo.com"}}]},{"text":" and we will guide you through the configuration.","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":"Account activities","type":"text"}]},{"type":"expand","attrs":{"title":"Internal process and deduplication method"},"content":[{"type":"paragraph","content":[{"text":"Account activities are continuously fetched since the last known record time. Events are sorted by the ","type":"text"},{"text":"created","type":"text","marks":[{"type":"code"}]},{"text":" field. The last known event time for a given batch of record(s) and the ID associated with the latest record(s) are persisted and referenced in the subsequent pull. Account activities are deduplicated by the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" field.","type":"text"}]}]},{"type":"expand","attrs":{"title":"Flattening"},"content":[{"type":"paragraph","content":[{"text":"Account activities are flattened on the ","type":"text"},{"text":"items","type":"text","marks":[{"type":"code"}]},{"text":" field. Each resultant record includes all the fields of the parent object, the target child object, and fields identifying the index of the target child object.","type":"text"}]}]},{"type":"expand","attrs":{"title":"Devo categorization and destination"},"content":[{"type":"paragraph","content":[{"text":"All events are sent by default to","type":"text"},{"text":" iam.sailpoint.identitynow.account_activity.","type":"text","marks":[{"type":"code"}]}]}]},{"type":"expand","attrs":{"title":"Verify data collection"},"content":[{"type":"paragraph","content":[{"text":"Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.","type":"text"}]},{"type":"paragraph","content":[{"text":"This service has the following components:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"0fc14022-ade5-4eae-ba9b-eaa9749ea4a9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Component","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[626.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Setup","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[626.0]},"content":[{"type":"paragraph","content":[{"text":"The setup module is in charge of authenticating the service and managing the token expiration when needed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Puller","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[626.0]},"content":[{"type":"paragraph","content":[{"text":"The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Setup output","type":"text"}]},{"type":"paragraph","content":[{"text":"A successful run has the following output messages for the setup module:","type":"text"}]},{"type":"codeBlock","content":[{"text":"2023-02-08T08:41:12.056 INFO InputProcess::MainThread -> SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> Starting thread\n2023-02-08T08:41:12.057 INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> No API client found\n2023-02-08T08:41:12.057 INFO InputProcess::MainThread -> SailpointPuller(sailpoint,111,account_activities,predefined) - Starting thread\n2023-02-08T08:41:12.058 WARNING InputProcess::SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> The token/header/authentication has not been created yet\n2023-02-08T08:41:12.058 WARNING InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Waiting until setup will be executed\n2023-02-08T08:41:12.059 INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> Creating API client.\n2023-02-08T08:41:12.721 INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> Client fetch method get_account_activities is valid for the given credentials.\n2023-02-08T08:41:12.724 INFO OutputProcess::ConsoleSender(standard_senders,console_sender_0) -> {\"timestamp\": \"2023-02-08 13:41:12.721\", \"tag\": \"devo.collectors.out.local.info\", \"content\": \"{\\\"msg\\\": \\\"Client fetch method get_account_activities is valid for the given credentials.\\\", \\\"time\\\": \\\"2023-02-08T13:41:12.721867Z\\\", \\\"level\\\": \\\"info\\\", \\\"collector_name\\\": \\\"unknown\\\", \\\"collector_version\\\": \\\"unknown\\\", \\\"collector_image\\\": null, \\\"input_name\\\": \\\"sailpoint\\\", \\\"service_name\\\": \\\"account_activities\\\", \\\"module_name\\\": \\\"SailpointPuller\\\"}\"}\n2023-02-08T08:41:13.307 INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> Setup for module has been successfully executed","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Puller output","type":"text"}]},{"type":"paragraph","content":[{"text":"A successful initial run has the following output messages for the puller module:","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note that the ","type":"text"},{"text":"PrePull","type":"text","marks":[{"type":"code"}]},{"text":" action is executed only one time before the first run of the ","type":"text"},{"text":"Pull","type":"text","marks":[{"type":"code"}]},{"text":" action.","type":"text"}]}]},{"type":"codeBlock","content":[{"text":"2023-02-08T08:50:47.043 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> SailpointPuller(sailpoint,111,account_activities,predefined) Starting the execution of pre_pull()\n2023-02-08T08:50:47.043 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Reading persisted data\n2023-02-08T08:50:47.044 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Data retrieved from the persistence: {'initial_start_time_in_utc': '2022-01-01T19:26:03.351000Z', 'last_event_time_in_utc': '2023-02-08T02:06:27.485000Z', 'last_ids': ['4014c5538cf74f7388cffb36dd2b8da9'], '@persistence_version': 1}\n2023-02-08T08:50:47.046 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Running the persistence upgrade steps\n2023-02-08T08:50:47.046 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Running the persistence corrections steps\n2023-02-08T08:50:47.046 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Running the persistence corrections steps\n2023-02-08T08:50:47.048 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Detected initial start time in UTC change: {'values_changed': {'root': {'new_value': '2023-01-01T19:26:03.351000Z', 'old_value': '2022-01-01T19:26:03.351000Z'}}}. Resetting state to {'initial_start_time_in_utc': '2023-01-01T19:26:03.351000Z', 'last_event_time_in_utc': '2023-01-01T19:26:03.351000Z', 'last_ids': [], '@persistence_version': 1}\n2023-02-08T08:50:47.049 WARNING InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: {'initial_start_time_in_utc': '2022-01-01T19:26:03.351000Z', 'last_event_time_in_utc': '2023-02-08T02:06:27.485000Z', 'last_ids': ['4014c5538cf74f7388cffb36dd2b8da9'], '@persistence_version': 1}. New content: {'initial_start_time_in_utc': '2023-01-01T19:26:03.351000Z', 'last_event_time_in_utc': '2023-01-01T19:26:03.351000Z', 'last_ids': [], '@persistence_version': 1}\n2023-02-08T08:50:47.054 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Updating the persistence\n2023-02-08T08:50:47.054 WARNING InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Persistence has been updated successfully\n2023-02-08T08:50:47.055 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> SailpointPuller(sailpoint,111,account_activities,predefined) Finalizing the execution of pre_pull()\n2023-02-08T08:50:47.055 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Starting data collection every 60 seconds\n2023-02-08T08:50:47.055 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Pull Started\n2023-02-08T08:50:47.056 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Retrieving/sending account_activities event(s) having created between 2023-01-01T19:26:03.351000+00:00 and 2023-02-08T13:50:47.042987+00:00\n2023-02-08T08:50:49.309 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Retrieved 250 account_activities event(s)\n2023-02-08T08:50:49.462 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Flattened 250 account_activities event(s) to 2463 event(s)\n2023-02-08T08:50:49.752 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Updating the persistence\n2023-02-08T08:50:49.753 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1675864247042):Number of requests made: 1; Number of events received: 250; Number of duplicated events filtered out: 0; Number of events generated and sent: 2463; Average of events per second: 913.145.\n2023-02-08T08:50:49.753 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Retrieving/sending account_activities event(s) having created between 2023-02-02T02:15:08.911000+00:00 and 2023-02-08T13:50:47.042987+00:00\n2023-02-08T08:50:50.306 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Retrieved 49 account_activities event(s)\n2023-02-08T08:50:50.332 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Flattened 49 account_activities event(s) to 486 event(s)\n2023-02-08T08:50:50.391 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Updating the persistence\n2023-02-08T08:50:50.392 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1675864247042):Number of requests made: 2; Number of events received: 299; Number of duplicated events filtered out: 12; Number of events generated and sent: 2937; Average of events per second: 880.217.\n2023-02-08T08:50:50.393 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Retrieving/sending account_activities event(s) having created between 2023-02-08T02:06:27.485000+00:00 and 2023-02-08T13:50:47.042987+00:00\n2023-02-08T08:50:50.474 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Retrieved 1 account_activities event(s)\n2023-02-08T08:50:50.475 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Flattened 1 account_activities event(s) to 12 event(s)\n2023-02-08T08:50:50.475 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> No events found after filtering. No further queries will be done.\n2023-02-08T08:50:50.475 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1675864247042):Number of requests made: 3; Number of events received: 300; Number of duplicated events filtered out: 24; Number of events generated and sent: 2937; Average of events per second: 858.848.\n2023-02-08T08:50:50.475 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1675864247042):Number of requests made: 3; Number of events received: 300; Number of duplicated events filtered out: 24; Number of events generated and sent: 2937; Average of events per second: 858.817.\n2023-02-08T08:50:50.475 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> The data is up to date!","type":"text"}]},{"type":"paragraph","content":[{"text":"After a successful collector’s execution (that is, no error logs found), you will see the following log message:","type":"text"}]},{"type":"codeBlock","content":[{"text":"2023-02-08T08:50:50.475 INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1675864247042):Number of requests made: 3; Number of events received: 300; Number of duplicated events filtered out: 24; Number of events generated and sent: 2937; Average of events per second: 858.817.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The value ","type":"text"},{"text":"@devo_pulling_id","type":"text","marks":[{"type":"code"}]},{"text":" is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that ","type":"text"},{"text":"Pull","type":"text","marks":[{"type":"code"}]},{"text":" action in Devo’s search window.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Events service","type":"text"}]},{"type":"expand","attrs":{"title":"Internal process and deduplication method"},"content":[{"type":"paragraph","content":[{"text":"Events are continuously fetched since the last known record time. Events are sorted by the ","type":"text"},{"text":"created","type":"text","marks":[{"type":"code"}]},{"text":" field. The last known record time for a given batch of record(s) and the ID associated with the latest record(s) are persisted and referenced in the subsequent pull. Events are deduplicated by the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" field.","type":"text"}]}]},{"type":"expand","attrs":{"title":"Devo categorization and destination"},"content":[{"type":"paragraph","content":[{"text":"All events are sent by default to ","type":"text"},{"text":"iam.sailpoint.identitynow.event.","type":"text","marks":[{"type":"code"}]}]}]},{"type":"expand","attrs":{"title":"Verify data collection"},"content":[{"type":"paragraph","content":[{"text":"Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.","type":"text"}]},{"type":"paragraph","content":[{"text":"This service has the following components:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"8147ef49-d667-41b2-b32d-001040c3ddd3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"Component","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[628.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"Setup","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[628.0]},"content":[{"type":"paragraph","content":[{"text":"The setup module is in charge of authenticating the service and managing the token expiration when needed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"Puller","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[628.0]},"content":[{"type":"paragraph","content":[{"text":"The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Setup output","type":"text"}]},{"type":"paragraph","content":[{"text":"A successful run has the following output messages for the setup module:","type":"text"}]},{"type":"codeBlock","content":[{"text":"2023-02-08T08:52:13.165 INFO InputProcess::MainThread -> SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Starting thread\n2023-02-08T08:52:13.165 INFO InputProcess::MainThread -> SailpointPuller(sailpoint,111,events,predefined) - Starting thread\n2023-02-08T08:52:13.165 WARNING InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Waiting until setup will be executed\n2023-02-08T08:52:13.166 INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> No API client found\n2023-02-08T08:52:13.166 WARNING InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> The token/header/authentication has not been created yet\n2023-02-08T08:52:13.166 INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Creating API client.\n2023-02-08T08:52:13.592 INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Created request client: \n2023-02-08T08:52:13.592 INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Testing client fetch method get_events...\n2023-02-08T08:52:13.661 INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Client fetch method get_events is valid for the given credentials.\n2023-02-08T08:52:14.101 INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Setup for module has been successfully executed","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Puller output","type":"text"}]},{"type":"paragraph","content":[{"text":"A successful initial run has the following output messages for the puller module:","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note that the ","type":"text"},{"text":"PrePull","type":"text","marks":[{"type":"code"}]},{"text":" action is executed only one time before the first run of the ","type":"text"},{"text":"Pull","type":"text","marks":[{"type":"code"}]},{"text":" action.","type":"text"}]}]},{"type":"codeBlock","content":[{"text":"2023-02-08T08:52:14.171 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> SailpointPuller(sailpoint,111,events,predefined) Starting the execution of pre_pull()\n2023-02-08T08:52:14.172 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Reading persisted data\n2023-02-08T08:52:14.174 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Data retrieved from the persistence: None\n2023-02-08T08:52:14.177 WARNING InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Persistence will be overridden due to the retrieved state is empty\n2023-02-08T08:52:14.177 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Running the persistence upgrade steps\n2023-02-08T08:52:14.178 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Running the persistence corrections steps\n2023-02-08T08:52:14.178 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Running the persistence corrections steps\n2023-02-08T08:52:14.181 WARNING InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: None. New content: {'initial_start_time_in_utc': '2023-01-20T19:26:03.351000Z', 'last_event_time_in_utc': '2023-01-20T19:26:03.351000Z', 'last_ids': []}\n2023-02-08T08:52:14.186 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Updating the persistence\n2023-02-08T08:52:14.187 WARNING InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Persistence has been updated successfully\n2023-02-08T08:52:14.187 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> SailpointPuller(sailpoint,111,events,predefined) Finalizing the execution of pre_pull()\n2023-02-08T08:52:14.187 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Starting data collection every 60 seconds\n2023-02-08T08:52:14.187 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Pull Started\n2023-02-08T08:52:14.189 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieving/sending events event(s) having created between 2023-01-20T19:26:03.351000+00:00 and 2023-02-08T13:52:14.171138+00:00\n2023-02-08T08:52:15.247 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieved 250 events event(s)\n2023-02-08T08:52:15.298 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Updating the persistence\n2023-02-08T08:52:15.299 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1675864334171):Number of requests made: 1; Number of events received: 250; Number of duplicated events filtered out: 0; Number of events generated and sent: 250; Average of events per second: 225.036.\n2023-02-08T08:52:15.299 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieving/sending events event(s) having created between 2023-01-29T05:34:12.827000+00:00 and 2023-02-08T13:52:14.171138+00:00\n2023-02-08T08:52:15.608 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieved 250 events event(s)\n2023-02-08T08:52:15.647 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Updating the persistence\n2023-02-08T08:52:15.648 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1675864334171):Number of requests made: 2; Number of events received: 500; Number of duplicated events filtered out: 1; Number of events generated and sent: 499; Average of events per second: 341.719.\n2023-02-08T08:52:15.648 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieving/sending events event(s) having created between 2023-02-07T05:39:44.674000+00:00 and 2023-02-08T13:52:14.171138+00:00\n2023-02-08T08:52:15.810 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieved 99 events event(s)\n2023-02-08T08:52:15.832 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Updating the persistence\n2023-02-08T08:52:15.833 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1675864334171):Number of requests made: 3; Number of events received: 599; Number of duplicated events filtered out: 2; Number of events generated and sent: 597; Average of events per second: 362.864.\n2023-02-08T08:52:15.833 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieving/sending events event(s) having created between 2023-02-08T13:52:13.981000+00:00 and 2023-02-08T13:52:14.171138+00:00\n2023-02-08T08:52:15.900 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieved 1 events event(s)\n2023-02-08T08:52:15.901 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> No events found after filtering. No further queries will be done.\n2023-02-08T08:52:15.901 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1675864334171):Number of requests made: 4; Number of events received: 600; Number of duplicated events filtered out: 3; Number of events generated and sent: 597; Average of events per second: 348.494.\n2023-02-08T08:52:15.901 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1675864334171):Number of requests made: 4; Number of events received: 600; Number of duplicated events filtered out: 3; Number of events generated and sent: 597; Average of events per second: 348.454.\n2023-02-08T08:52:15.901 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> The data is up to date!\n2023-02-08T08:52:15.901 INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Data collection completed. Elapsed time: 1.731 seconds. Waiting for 58.269 second(s) until the next one","type":"text"}]},{"type":"paragraph","content":[{"text":"After a successful collector’s execution (that is, no error logs found), you will see the following log message:","type":"text"}]},{"type":"codeBlock","content":[{"text":"InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1675864334171):Number of requests made: 4; Number of events received: 600; Number of duplicated events filtered out: 3; Number of events generated and sent: 597; Average of events per second: 348.454.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The value ","type":"text"},{"text":"@devo_pulling_id","type":"text","marks":[{"type":"code"}]},{"text":" is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that ","type":"text"},{"text":"Pull","type":"text","marks":[{"type":"code"}]},{"text":" action in Devo’s search window.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Restart the persistence"},"content":[{"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":"initial_start_time_in_utc","type":"text","marks":[{"type":"code"}]},{"text":" parameter 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":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Note that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Troubleshooting"},"content":[{"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","localId":"466b78f4-a3c5-4695-840d-1e198f8433fc"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"Error type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Error ID","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Error message","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Cause","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Solution","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariableError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"datetime_format is not set in service thread globals.","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Datetime format string not in internal config.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Input datetime format string in service thread globals.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariableError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"2","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Datetime format \"{datetime_format}\" is invalid","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Datetime format string does not render a valid datetime.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Update internal definition file with appropriate datetime format.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariableError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"3","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Date {ini_start_time_str} is in the future","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"initial_start_datetime_in_utc","type":"text","marks":[{"type":"code"}]},{"text":" is a future date.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Update config with appropriate ","type":"text"},{"text":"initial_start_datetime_in_utc ","type":"text","marks":[{"type":"code"}]},{"text":"value.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariableError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"request_retry_attempts is not set in service thread globals \" \"or module properties","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"request_retry_attempts","type":"text","marks":[{"type":"code"}]},{"text":" parameter is not configured.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"request_retry_attempts","type":"text","marks":[{"type":"code"}]},{"text":" in the service thread globals or module properties of the definition file.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariableError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"5","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"request_retry_attempts must be greater than or equal to 0","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"request_retry_attempts","type":"text","marks":[{"type":"code"}]},{"text":" parameter is less than 0.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"request_retry_attempts","type":"text","marks":[{"type":"code"}]},{"text":" parameter to any integer greater than or equal to 0.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariableError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"request_retry_attempts must be an integer","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"request_retry_attempts","type":"text","marks":[{"type":"code"}]},{"text":" parameter must be an integer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"request_retry_attempts","type":"text","marks":[{"type":"code"}]},{"text":" as an integer.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariableError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"7","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"request_retry_delay_in_seconds is not set in service thread globals \" \"or module properties","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"request_retry_delay_in_seconds ","type":"text","marks":[{"type":"code"}]},{"text":"parameter is not configured.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"request_retry_delay_in_seconds","type":"text","marks":[{"type":"code"}]},{"text":" in the service thread globals or module properties of the definition file.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariableError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"request_retry_delay_in_seconds must be greater than or equal to 0","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"request_retry_delay_in_seconds","type":"text","marks":[{"type":"code"}]},{"text":" parameter is less than 0.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"request_retry_delay_in_seconds ","type":"text","marks":[{"type":"code"}]},{"text":"parameter to any integer greater than or equal to 0.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"InitVariableError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"9","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"request_retry_delay_in_seconds must be an integer","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"request_retry_delay_in_seconds ","type":"text","marks":[{"type":"code"}]},{"text":"parameter must be an integer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"request_retry_delay_in_seconds","type":"text","marks":[{"type":"code"}]},{"text":" as an integer.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"SetupError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"101","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Client fetch method is not valid","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"The API wrapper is calling a non-existent API endpoint or lacks a fetch method for that endpoint.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Ensure the internal definition file has correct API endpoints.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"SetupError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"102","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"HTTP Error while making request to Sailpoint API: {error message}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"During the setup test (querying the endpoint), SailPoint responded with an unexpected error.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Review the error message to determine failure. If result of outage, allow collector to attempt authentication during next poll.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"PullError","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"350","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Failed to flatten event: {e} with key {by_key_path}. Exception: {e}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"The flattening method failed to flatten the indicated event.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[150.0]},"content":[{"type":"paragraph","content":[{"text":"Ensure that a correct flattening key is utilized for the event.","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 the 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-josemi-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-trend-micro-vision-one\\config\\config-josemi-test-local.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":"b4ce6589-85aa-4583-b31b-545216de40ff"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[379.0]},"content":[{"type":"paragraph","content":[{"text":"Sender services","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[379.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[379.0]},"content":[{"type":"paragraph","content":[{"text":"Number of available senders: 1","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[379.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":[379.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":[379.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":[379.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":[379.0]},"content":[{"type":"paragraph","content":[{"text":"Displayes 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","type":"text","marks":[{"type":"code"}]},{"text":" 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"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"21 events","type":"text","marks":[{"type":"code"}]},{"text":" where sent to Devo between the last UTC checkpoint and now.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Those","type":"text"},{"text":" 21 events","type":"text","marks":[{"type":"code"}]},{"text":" required","type":"text"},{"text":" 0.007 ","type":"text","marks":[{"type":"code"}]},{"text":"seconds to be delivered.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"By default these traces will be shown every 10 minutes.","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":"29088c87-06bc-4471-bc37-96b272ca1194"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[379.0]},"content":[{"type":"paragraph","content":[{"text":"Logging trace","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[379.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[379.0]},"content":[{"type":"paragraph","content":[{"text":"Number of available senders: 1","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[379.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":[379.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":[379.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":[379.0]},"content":[{"type":"paragraph","content":[{"text":"Standard - Total number of messages sent: 57, messages sent since \"2023-01-10 16:09:16.116750+00:00\": 0 (elapsed 0.000 seconds","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[379.0]},"content":[{"type":"paragraph","content":[{"text":"Displayes 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","type":"text","marks":[{"type":"code"}]},{"text":" 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":"2023-01-10 16:09:16.116750+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 ","type":"text"},{"text":"21 events","type":"text","marks":[{"type":"code"}]},{"text":" required ","type":"text"},{"text":"0.00 seconds","type":"text","marks":[{"type":"code"}]},{"text":" to be delivered.","type":"text"}]}]}]},{"type":"paragraph"}]}]}]}]},{"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 -> 410.02MiB)\nINFO OutputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(28.41MiB -> 28.41MiB), VMS(705.28MiB -> 705.28MiB)","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Differences between ","type":"text"},{"text":"RSS","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"VMS","type":"text","marks":[{"type":"code"}]},{"text":" memory usage:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RSS","type":"text","marks":[{"type":"code"}]},{"text":" is the Resident Set Size, which is the actual physical memory the process is using","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"VMS","type":"text","marks":[{"type":"code"}]},{"text":" is the Virtual Memory Size which is the virtual memory that process is using","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Enable/disable the logging debug mode"},"content":[{"type":"paragraph","content":[{"text":"Sometimes it is necessary to activate the debug mode of the collector's logging. This debug mode increases the verbosity of the log and allows you to print execution traces that are very helpful in resolving incidents or detecting bottlenecks in heavy download processes.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To enable this option you just need to edit the configuration file and change the debug_status parameter from false to true and restart the collector.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To disable this option, you just need to update the configuration file and change the debug_status parameter from true to false and restart the collector.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"For more information, visit the configuration and parameterization section corresponding to the chosen deployment mode.","type":"text"}]}]},{"type":"paragraph"}],"version":1}

Browser not supported