{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Welcome to the migration guide for ","type":"text"},{"text":"IBM Cloud activity tracker Collector_ version 2.0.0","type":"text","marks":[{"type":"strong"}]},{"text":"! This guide will walk you through the process of updating your configuration from the old version (1.0.0) to the new version (2.0.0). The new version introduces significant improvements and changes to the configuration style to enhance performance, usability, and security.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview of Changes","type":"text"}]},{"type":"paragraph","content":[{"text":"The new configuration format introduces several key changes:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Changed the name of the collector from ","type":"text"},{"text":"ibm cloud activity tracker","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"ibm cloud logs","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Migrated the collector from ","type":"text"},{"text":"ibm cloud activity tracker","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"ibm cloud logs","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"We are no longer using ","type":"text"},{"text":"v2/export","type":"text","marks":[{"type":"code"}]},{"text":" API to fetch the data.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Event streaming process (kafka) is used to fetch the data in the new version (v2.0.0).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name of the input is no longer ","type":"text"},{"text":"ibm_cloud_activity_tracker","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name of the input is ","type":"text"},{"text":"ibm_cloud_logs","type":"text","marks":[{"type":"code"}]},{"text":" in the config file.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Params ","type":"text"},{"text":"service_key","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"base_url","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"environment","type":"text","marks":[{"type":"code"}]},{"text":" has been removed and no longer needed in the new version (2.0.0).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Params ","type":"text"},{"text":"override_fetch_gap_seconds","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"start_time_in_utc","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"obfuscation_data","type":"text","marks":[{"type":"code"}]},{"text":" has been removed and no longer needed in the new version (2.0.0).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Added params ","type":"text"},{"text":"api_key","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"kafka_admin_url","type":"text","marks":[{"type":"code"}]},{"text":" in the configuration for authentication and to get the ","type":"text"},{"text":"iam_api_token","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"topic_name","type":"text","marks":[{"type":"code"}]},{"text":" respectively.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Added ","type":"text"},{"text":"auto_offset_reset","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"group_id","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"user_topic_name","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"bootstrap_endpoints","type":"text","marks":[{"type":"code"}]},{"text":" in the configuration.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"api_key","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"kafka_admin_url","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"bootstrap_endpoints","type":"text","marks":[{"type":"code"}]},{"text":" are required parameters for basic pulling.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Preparing for Migration","type":"text"}]},{"type":"paragraph","content":[{"text":"Before starting the migration process, we recommend the following steps:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Backup Your Current Configuration","type":"text","marks":[{"type":"strong"}]},{"text":": Always ensure you have a backup of your existing configuration files to prevent any data loss.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Review the New Configuration Documentation","type":"text","marks":[{"type":"strong"}]},{"text":": Familiarize yourself with the new ","type":"text"},{"text":"configuration options","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.devo.com/space/latest/413859841/IBM+Cloud+Activity+Tracker+collector#Minimum-configuration-required-for-basic-pulling"}}]},{"text":" available in version 2.0.0.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Migration Steps","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Step 1: Update the Service Configuration Parameter Field Name","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"An example of the old and new configuration is shown below:","type":"text"}]},{"type":"paragraph","content":[{"text":"Old version (1.0.0)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"services:\n activity_tracker:\n override_tag: \n override_fetch_gap_seconds: \n start_time_in_utc: \n obfuscation_data: []\n request_period_in_seconds: ","type":"text"}]},{"type":"paragraph","content":[{"text":"New version (2.0.0)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"services:\n activity_tracker:\n bootstrap_endpoints: \n auto_offset_reset: \n override_tag: \n group_id: \n user_topic_name: \n request_period_in_seconds: ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Step 2: Update in the services Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of the new configuration (v.2.0.0) is shown below:","type":"text"}]},{"type":"codeBlock","content":[{"text":"services:\n activity_tracker:\n bootstrap_endpoints: \n auto_offset_reset: \n override_tag: \n group_id: \n user_topic_name: \n request_period_in_seconds: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Added ","type":"text"},{"text":"bootstrap_endpoints","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"auto_offset_reset","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"group_id","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"user_topic_name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bootstrap_endpoints","type":"text","marks":[{"type":"code"}]},{"text":" is required parameter.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Step 3: Before and After Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"Putting it all together, see below for an example of the old and new configuration:","type":"text"}]},{"type":"paragraph","content":[{"text":"Old version (1.0.0)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"inputs:\n ibm_cloud_activity_tracker:\n id: \n enabled: true\n environment: \n base_url: \n credentials:\n service_key: \n services:\n activity_tracker:\n override_tag: \n override_fetch_gap_seconds: \n start_time_in_utc: \n obfuscation_data: []\n request_period_in_seconds: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name of the input has been changed as well from ","type":"text"},{"text":"ibm_cloud_activity_tracker","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"ibm_cloud_logs","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"service_key","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"base_url","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"environment","type":"text","marks":[{"type":"code"}]},{"text":" parameters are removed and no longer needed in the new version (v2.0.0).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"override_fetch_gap_seconds","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"start_time_in_utc","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"obfuscation_data","type":"text","marks":[{"type":"code"}]},{"text":" parameters are removed and no longer needed in the new version (v2.0.0).","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"New version (2.0.0)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"inputs:\n ibm_cloud_logs:\n id: \n enabled: true\n kafka_admin_url: \n credentials:\n api_key: \n services:\n activity_tracker:\n bootstrap_endpoints: \n auto_offset_reset: \n override_tag: \n group_id: \n user_topic_name: \n request_period_in_seconds: \n","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Added ","type":"text"},{"text":"kafka_admin_url","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"api_key","type":"text","marks":[{"type":"code"}]},{"text":" for authentication and to get the description topic and ","type":"text"},{"text":"topic_name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"override_tag","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"request_period_in_seconds","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"user_topic_name","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"group_id","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"auto_offset_reset","type":"text","marks":[{"type":"code"}]},{"text":" are optional parameters","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"api_key","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"kafka_admin_url","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"bootstrap_endpoints","type":"text","marks":[{"type":"code"}]},{"text":" are required parameters","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Tag and Table of new version is same as of the old version ","type":"text"},{"text":"cloud.ibm.activity_tracker.audit","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Step 4: json of the old and new version","type":"text"}]},{"type":"paragraph","content":[{"text":"Old version (1.0.0)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"{\n \"global_overrides\": {\n \"debug\": false\n },\n \"inputs\": {\n \"ibm_cloud_activity_tracker\": {\n \"id\": \"\",\n \"enabled\": true,\n \"environment\": \"\",\n \"base_url\": \"\",\n \"credentials\": {\n \"service_key\": \"\"\n },\n \"services\": {\n \"activity_tracker\": {\n \"override_tag\": \"\",\n \"override_fetch_gap_seconds\": \"\",\n \"start_time_in_utc\": \"\",\n \"obfuscation_data\": [\"\"],\n \"request_period_in_seconds\": \"\"\n }\n }\n }\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"New version (2.0.0)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"{\n \"global_overrides\": {\n \"debug\": false\n },\n \"inputs\": {\n \"ibm_cloud_logs\": {\n \"id\": \"\",\n \"enabled\": true,\n \"kafka_admin_url\": \"\",\n \"credentials\": {\n \"api_key\": \"\"\n },\n \"services\": {\n \"activity_tracker\": {\n \"bootstrap_endpoints\": \"\",\n \"group_id\": \"group_id\",\n \"override_tag\": \"\",\n \"auto_offset_reset\": \"\",\n \"user_topic_name\": \"\",\n \"request_period_in_seconds\": \"\"\n }\n }\n }\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Conclusion","type":"text"}]},{"type":"paragraph","content":[{"text":"Following these steps should help you smoothly transition to the new version of ","type":"text"},{"text":"Software Script","type":"text","marks":[{"type":"em"}]},{"text":". If you encounter any issues, don't hesitate to ","type":"text"},{"text":"reach out for support","type":"text","marks":[{"type":"link","attrs":{"href":"https://devo.my.site.com/support/login?ec=302&startURL=%2Fsupport%2Fs%2F"}}]},{"text":".","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported