@thinkingai/ae-cli 1.0.30 → 6.0.16-1

package/wiki/te-docs/raw/data-ingestion-guide/data-import-tools/ta-datax-writer-plugin-user-guide.md

@@ -0,0 +1,278 @@
+---
+code: ta-datax-writer
+name: "Ta-Datax-Writer Plugin User Guide"
+wikiToken: ITEuwWzGsiNarbkCottcVhkWnLd
+parentWikiToken: S9D7wPqKDiC6zhkvv2dc6MgonCg
+updateTime: 1774249353000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=ta-datax-writer
+---
+
+## I. Introduction
+Ta-Datax-Writer is a DataX plugin for writing data, which provides the function of transmitting data to TA clusters in the DataX ecosystem. You can deploy DataX on the data transmission server, and use the data source supported by DataX to read the plugin and this plugin, thus achieving data synchronization between multiple data sources and TA clusters.
+To learn about DataX, you can visit [DataX's Github homepage](https://github.com/ThinkingDataAnalytics/DataX)
+**The data is sent to the TA receiver for data transmission**
+## II. Functions and limitations
+TaDataWriter can convert the data from the DataX protocol to the internal data in the TA clusters. TaDataWriter has the following functions:
+1. Support and only support writing to TA clusters.
+2. Support data compression. Existing compression formats are gzip, lzo, lz4, and snappy.
+3. Support multi-thread transmission.
+## III. Use instructions
+### 3.1 Download datax
+- Visit DataX [official website](https://github.com/ThinkingDataAnalytics/DataX)
+- Download DataX toolkit: [DataX download](https://download.thinkingdata.cn/tools/datax/datax.tar.gz)
+```bash
+wget http://datax-opensource.oss-cn-hangzhou.aliyuncs.com/datax.tar.gz
+```
+
+<image token="Ong7bmb09o2kyZxFGUMcMOx3nPf" width="978" height="172" align="center"/>
+
+### 3.2 Decompress datax
+```bash
+tar -zxvf datax.tar.gz
+```
+
+### 3.3 Install the ta-datax-writer plugin
+- Download the ta-datax-writer plugin: [ta-datax-writer download](https://download.thinkingdata.cn/tools/release/ta-datax-writer.tar.gz)
+```bash
+wget https://download.thinkingdata.cn/tools/release/ta-datax-writer.tar.gz
+```
+
+- Copy ta-datax-writer.tar.gz to the data/plugin/writer directory
+```bash
+cp ta-datax-writer.tar.gz data/plugin/writer
+```
+
+<image token="FWcEbhsKSo2KQCxZOECc2EBpnJb" width="687" height="380" align="center"/>
+
+- Decompress the plugin package
+```bash
+tar -zxvf ta-datax-writer.tar.gz
+```
+
+- Remove package
+```bash
+rm -rf  ta-datax-writer.tar.gz
+```
+
+<image token="QqolbX0unokOt2xKmWgc8EwtnJg" width="494" height="384" align="center"/>
+
+## IV. Functions
+### 4.1 Configuration example
+```json
+{
+  "job": {
+    "setting": {
+      "speed": {
+        "channel": 1
+      }
+    },
+    "content": [
+      {
+        "reader": {
+          "name": "streamreader",
+          "parameter": {
+            "column": [
+              {
+                "value": "123123",
+                "type": "string"
+              },
+              {
+                "value": "testbuy",
+                "type": "string"
+              },
+              {
+                "value": "2019-08-16 08:08:08",
+                "type": "date"
+              },
+              {
+                "value": "2222",
+                "type": "string"
+              },
+              {
+                "value": "2019-08-16 08:08:08",
+                "type": "date"
+              },
+              {
+                "value": "test",
+                "type": "bytes"
+              },
+              {
+                "value": true,
+                "type": "bool"
+              }
+            ],
+            "sliceRecordCount": 10
+          }
+        },
+        "writer": {
+          "name": "ta-datax-writer",
+          "parameter": {
+            "thread": 3,
+            "type": "track",
+            "pushUrl": "http://{data receiving address}",
+            "appid": "6f9e64da5bc74792b9e9c1db4e3e3822",
+            "column": [
+              {
+                "index": "0",
+                "colTargetName": "#distinct_id"
+              },
+              {
+                "index": "1",
+                "colTargetName": "#event_name"
+              },
+              {
+                "index": "2",
+                "colTargetName": "#time",
+                "type": "date",
+                "dateFormat": "yyyy-MM-dd HH:mm:ss.SSS"
+              },
+              {
+                "index": "3",
+                "colTargetName": "#account_id",
+                "type": "string"
+              },
+              {
+                "index": "4",
+                "colTargetName": "testDate",
+                "type": "date",
+                "dateFormat": "yyyy-MM-dd HH:mm:ss.SSS"
+              },
+              {
+                "index": "5",
+                "colTargetName": "os_1",
+                "type": "string"
+              },
+              {
+                "index": "6",
+                "colTargetName": "testBoolean",
+                "type": "boolean"
+              },
+              {
+                "colTargetName": "add_clo",
+                "value": "123123",
+                "type": "string"
+              }
+            ]
+          }
+        }
+      }
+    ]
+  }
+}
+```
+
+### 4.2 Parameter description
+- **thread**
+  - Description: number of threads, used concurrently within each channel, not related to the number of channels in DataX. 
+  - Required: No
+  - Default value: 3
+- **pushUrl**
+  - Description: Access point address. 
+  - Required: Yes
+  - Default value: none 
+- **uuid**
+  - Description: Add "#uuid": "uuid value" in the transmitted data, and enable it with the [<text color="purple" underline="true">data unique ID</text>](https://thinkingdata.feishu.cn/wiki/wikcnUg2hivNLwUSLDKM2ITS0Sf#uRcTdS) function.
+  - Required: No 
+  - Default value: false 
+- **type**
+  - Description: written data type support user_set, track.
+  - Required: Yes
+  - Default value: none
+- **compress**
+  - Description: Text compression type, "not filled by default" means no compression. The supported compression types are zip, lzo, lzop, tgz, and bzip2.
+  - Required: No
+  - Default value: no compression
+- **appid**
+  - Description: project appid.
+  - Required: Yes
+  - Default value: none 
+- **column**
+  - Description:a list of fields to read. type specifies the data type, and index specifies the current column corresponding to the column of the reader (starting with 0); value specifies that the current type is constant. It does not read data from the reader, but automatically generates a column based on the value.
+The user can specify the Column field as follows:
+```json {wrap}
+[
+  {
+    "type": "Number",
+    "colTargetName": "test_col", // generate column name corresponding to data
+    "index": 0 //transmit the first column from reader to datax and get the Number field
+  },
+  {
+    "type": "string",
+    "value": "testvalue",
+    "colTargetName": "test_col"
+    //generate the string field of testvalue fromTaDataWriter as the current field
+  },
+  {
+    "index": 0,
+    "type": "date",
+    "colTargetName": "testdate",
+    "dateFormat": "yyyy-MM-dd HH:mm:ss.SSS"
+  }
+]
+```
+
+- For the Column information specified by the user, at least one of index and value must be selected, and the type is not required. When setting the date type, dataFormat is optional.
+  - Required: Yes
+  - Default value: all read according to the reader type 
+### 4.3 Type conversion
+The type is TaDataWriter definition:
+
+<lark-table rows="7" cols="2" column-widths="365,365">
+
+  <lark-tr>
+    <lark-td>
+      **DataX internal type**
+    </lark-td>
+    <lark-td>
+      **TaDataWriter data type**
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      Int
+    </lark-td>
+    <lark-td>
+      Number
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      Long
+    </lark-td>
+    <lark-td>
+      Number
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      Double
+    </lark-td>
+    <lark-td>
+      Number
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      String
+    </lark-td>
+    <lark-td>
+      String
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      Boolean
+    </lark-td>
+    <lark-td>
+      Boolean
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      Date
+    </lark-td>
+    <lark-td>
+      Date
+    </lark-td>
+  </lark-tr>
+</lark-table>

package/wiki/te-docs/raw/data-ingestion-guide/data-import-tools.md

@@ -0,0 +1,15 @@
+---
+code: data_import_menu
+name: "Data Import Tools"
+wikiToken: S9D7wPqKDiC6zhkvv2dc6MgonCg
+parentWikiToken: AWr4wIMGYi9FB7ksPi4c17kNnxh
+updateTime: 1774252022000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=data_import_menu
+---
+
+Data import mainly has the following tools:
+- [LogBus](https://thinkingdata.feishu.cn/wiki/HoUywXWnNiqVfWkTJXwcbFG8n0c)[2](https://thinkingdata.feishu.cn/wiki/HoUywXWnNiqVfWkTJXwcbFG8n0c)[ User Guide](https://thinkingdata.feishu.cn/wiki/HoUywXWnNiqVfWkTJXwcbFG8n0c)
+- [LogBus User Guide](https://thinkingdata.feishu.cn/wiki/SlE6wOEK3isQvukzEbnc5V0inNa)
+- [LogBus Windows Version Guide](https://thinkingdata.feishu.cn/wiki/VL6lw7ysciezGZkA1J6cHQmhnSd)
+- [Filebeat + Logstash User Guide](https://thinkingdata.feishu.cn/wiki/PX2xwuYOwiaSnOkWUjrcNm0lnGf)
+- [ta-datax-writer Plugin User Guide](https://thinkingdata.feishu.cn/wiki/Taa9wJpfHiBIgckwrQtcGauRnTh)

package/wiki/te-docs/raw/data-ingestion-guide/privacy-policy.md

@@ -0,0 +1,38 @@
+---
+code: privacy
+name: "Privacy Policy"
+wikiToken: E9QdwJoYFiT2MNkzitocTHiVn5g
+parentWikiToken: AWr4wIMGYi9FB7ksPi4c17kNnxh
+updateTime: 1774249361000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=privacy
+---
+
+ThinkingData operates the www.thinkingdata.cn website, which provides the SERVICE.
+ This page is used to inform website visitors regarding our policies with the collection, use, and disclosure of Personal Information if anyone decided to use our Service, the www.thinkingdata.cn website.
+If you choose to use our Service, then you agree to the collection and use of information in relation with this policy. The Personal Information that we collect are used for providing and improving the Service. We will not use or share your information with anyone except as described in this Privacy Policy.
+The terms used in this Privacy Policy have the same meanings as in our Terms and Conditions, which is accessible at www.thinkingdata.cn, unless otherwise defined in this Privacy Policy. Our Privacy Policy was created with the help of the [Privacy Policy Template](https://www.privacypolicytemplate.net) and the [Disclaimer Generator](https://www.disclaimergenerator.org).
+## Information Collection and Use
+For a better experience while using our Service, we may require you to provide us with certain personally identifiable information, including but not limited to your name, phone number, and postal address. The information that we collect will be used to contact or identify you.
+## Log Data
+We want to inform you that whenever you visit our Service, we collect information that your browser sends to us that is called Log Data. This Log Data may include information such as your computer's Internet Protocol ("IP") address, browser version, pages of our Service that you visit, the time and date of your visit, the time spent on those pages, and other statistics.
+## Cookies
+Cookies are files with small amount of data that is commonly used an anonymous unique identifier. These are sent to your browser from the website that you visit and are stored on your computer's hard drive.
+Our website uses these "cookies" to collection information and to improve our Service. You have the option to either accept or refuse these cookies, and know when a cookie is being sent to your computer. If you choose to refuse our cookies, you may not be able to use some portions of our Service.
+For more general information on cookies, please read "[What Are Cookies](https://www.cookieconsent.com/what-are-cookies/)".
+## Service Providers
+We may employ third-party companies and individuals due to the following reasons:
+- To facilitate our Service;
+- To provide the Service on our behalf;
+- To perform Service-related services; or
+- To assist us in analyzing how our Service is used.
+We want to inform our Service users that these third parties have access to your Personal Information. The reason is to perform the tasks assigned to them on our behalf. However, they are obligated not to disclose or use the information for any other purpose.
+## Security
+We value your trust in providing us your Personal Information, thus we are striving to use commercially acceptable means of protecting it. But remember that no method of transmission over the internet, or method of electronic storage is 100% secure and reliable, and we cannot guarantee its absolute security.
+## Links to Other Sites
+Our Service may contain links to other sites. If you click on a third-party link, you will be directed to that site. Note that these external sites are not operated by us. Therefore, we strongly advise you to review the Privacy Policy of these websites. We have no control over, and assume no responsibility for the content, privacy policies, or practices of any third-party sites or services.
+## Children's Privacy
+Our Services do not address anyone under the age of 13. We do not knowingly collect personal identifiable information from children under 13. In the case we discover that a child under 13 has provided us with personal information, we immediately delete this from our servers. If you are a parent or guardian and you are aware that your child has provided us with personal information, please contact us so that we will be able to do necessary actions.
+## Changes to This Privacy Policy
+We may update our Privacy Policy from time to time. Thus, we advise you to review this page periodically for any changes. We will notify you of any changes by posting the new Privacy Policy on this page. These changes are effective immediately, after they are posted on this page.
+## Contact Us
+If you have any questions or suggestions about our Privacy Policy, do not hesitate to contact us.

package/wiki/te-docs/raw/data-ingestion-guide/restful-api-user-guide.md

@@ -0,0 +1,155 @@
+---
+code: restful_api
+name: "Restful API User Guide"
+wikiToken: Jsp1w2ewJiXA2wkBvU8ckXxhn6g
+parentWikiToken: AWr4wIMGYi9FB7ksPi4c17kNnxh
+updateTime: 1774252026000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=restful_api
+---
+
+This user guide will introduce how to use the data access API. Depending on the data access API, you can directly transmit data to the ThinkingAnalytics background by using the HTTP POST method, without relying on a transmission tool and SDK.
+**Before docking, you need to read the **<text underline="true">**data rules**</text>** first, and then read this user guide after you have been familiar with TA's data format and data rules.**
+**POST must upload data in the **<text underline="true">**data forma…</text>**<text underline="true">** **</text>**of ****the ****TA**
+## I. Data format conversion
+Before data upload, the format of the data needs to be converted to TA's data format first. Each piece of data in TA is a JSON. The data sample is as follows (for the convenience of reading, the data has been formatted):
+```json
+{
+  "#account_id": "ABCDEFG-123-abc",
+  "#distinct_id": "F53A58ED-E5DA-4F18-B082-7E1228746E88",
+  "#type": "track",
+  "#ip": "192.168.171.111",
+  "#time": "2017-12-18 14:37:28.527",
+  "#event_name": "test",
+  "properties": {
+    "#lib": "LogBus",
+    "#lib_version": "1.0.0",
+    "#screen_height": 1920,
+    "#screen_width": 1080,
+    "argString": "abc",
+    "argNum": 123,
+    "argBool": true
+  }
+}
+```
+
+For specific data format specifications, please refer to <text underline="true">**data format**</text>.
+## II. Data reporting
+When you have prepared the JSON data, you can report the data. The TA background accepts the calling request of the HTTP standard POST method, and the character set of all interface data is encoded by the UTF-8 method. The specific calling method is as follows:
+### 2.1 Data receiving interface (form-data)
+If you are using a cloud service, please enter the following URL:
+https://global-receiver-ta.thinkingdata.cn/sync_data
+If you are using a privately deployed version, please enter the following URL:
+http://`data acquisition address`/sync_data
+#### 2.1.1 Receive parameters (written in requestBody)
+- If it is a piece of json data:
+  - Parameter 1: appid= your project APPID
+  - Parameter 2: data=JSON data, UTF-8 encoding, urlencode encoding required
+  - Parameter 3: client=0, default 0, when it is set to 1, take the reporting terminal ip as the #ip field (mandatory substitution)
+- If there are multiple pieces of data:
+  - Parameter 1: appid= your project APPID
+  - Parameter 2: data_list=JSONArray data, including multiple pieces of JSON data, UTF-8 encoding, urlencode encoding required
+  - Parameter 3: client=0, default 0, when it is set to 1, take the reporting terminal ip as the #ip field (mandatory substitution)
+**Note:** Libraries in different languages may have their own urlencode, and there is no need to urlencode again at this time, such as the requests library of Python3 and the request test of postman.
+The following demonstrates how to call the RESTful API through `curl`, and the following data is the source data
+```json
+{
+  "#account_id": "testing",
+  "#time": "2019-01-01 10:00:00.000",
+  "#type": "track",
+  "#event_name": "testing",
+  "properties": {
+    "test": "test"
+  }
+}
+```
+
+The above data needs to be urlencoded first
+```perl
+%7b%22%23account_id%22%3a%22testing%22%2c%22%23time%22%3a%222019-01-01+10%3a00%3a00.000%22%2c%22%23type%22%3a%22track%22%2c%22%23event_name%22%3a%22testing%22%2c%22properties%22%3a%7b%22test%22%3a%22test%22%7d%7d
+```
+
+Add parameters and report data
+```plaintext
+curl "http://receiver:9080/sync_data" --data "appid=test-sdk-appid&data=%7b%22%23account_id%22%3a%22testing%22%2c%22%23time%22%3a%222019-01-01+10%3a00%3a00.000%22%2c%22%23type%22%3a%22track%22%2c%22%23event_name%22%3a%22testing%22%2c%22properties%22%3a%7b%22test%22%3a%22test%22%7d%7d"
+```
+
+#### 2.1.2 Return parameters
+If the return parameter is received, code: 0, it means that the data has been successfully transmitted
+#### 2.1.3 Debug mode
+In the upload parameters, you can add the debug parameters (that is, three upload parameters, appid, data\\data_list, debug). You don't have to upload it, and the default is off
+The Debug mode is enabled only when a small amount of test data is uploaded. Please do not enable the Debug mode in the production environment
+When `debug=1`, the return result will show detailed error reasons, for example:
+`{"code":-1,"msg":"The format of the #time field is incorrect, and the format of [yyyy-MM-dd HH:mm:ss] or [yyyy-MM-dd HH:mm:ss.SSS] needs to be passed" }`
+### 2.2 Data receiving interface (raw)
+If you are using a cloud service, please enter the following URL:
+```css
+https://global-receiver-ta.thinkingdata.cn/sync_json
+```
+
+If you are using a privately deployed version, please enter the following URL:
+```groovy
+http://data acquisition address/sync_json
+```
+
+#### 2.2.1 Receive parameters (written in requestBody)
+- If it is a piece of json data:
+```json
+{
+  "appid": "debug-appid",
+  "debug": 0,
+  "data": {
+    "#type": "track",
+    "#event_name": "test",
+    "#time": "2019-11-15 11:35:53.648",
+    "properties": { "a": "123", "b": 2 },
+    "#distinct_id": "1111"
+  }
+}
+```
+
+- If there are multiple pieces of data:
+```json
+[
+    {
+        "appid": "debug-appid",
+        "debug": 0,
+        "data": {
+          "#type": "track",
+          "#event_name": "test",
+          "#time": "2019-11-15 11:35:53.648",
+          "properties": { "a": "123", "b": 2 },
+          "#distinct_id": "1111"
+        },
+    {
+        "appid": "debug-appid",
+        "debug": 0,
+        "data": {
+          "#type": "track",
+          "#event_name": "test",
+          "#time": "2019-11-15 11:35:53.648",
+          "properties": { "a": "123", "b": 2 },
+          "#distinct_id": "1111"
+        }
+    }
+}
+```
+
+#### 2.2.2 Return parameters:
+If the return parameter is received, code: 0, it means that the data has been successfully transmitted
+#### 2.2.3 Debug mode
+In the upload parameters, you can add the debug parameter (that is, add debug parameter in json), you don't have to upload it, and the default is off
+**The Debug mode is enabled only when a small amount of test data is uploaded. Please do not enable the Debug mode in the production environment**
+When debug=1, the return result will show detailed error reasons, for example:
+```json {wrap}
+{
+  "code": -1,
+  "msg": "# the format of the time field is incorrect. You need to pass the format yyyy-MM-dd HH:mm:ss or yyyy-MM-dd HH:mm: ss.sss].
+}
+```
+
+#### 2.2.4 Data compression
+Add the compress field in the RequestHeader to upload compressed data. For example, if you upload compress=gzip, the server will decompress the data by gzip. The available compression methods are gzip, lzo, lz4, and snappy, and the default is no compression.
+#### 2.2.5 Get the reporting terminal ip
+Add client=1 in RequestHeader. At this time, the server will take the reporting terminal ip as the #ip field (mandatory substitution), and the default value is 0, that is, the reporting terminal ip will not be substituted
+## III. FAQs
+Please refer to the <text underline="true">data rule FAQs</text> and troubleshoot data transmission exceptions caused by data format problems.

package/wiki/te-docs/raw/data-ingestion-guide/server-sdk/c/c-advanced/debugging-and-logging-FM9Cwz.md

@@ -0,0 +1,37 @@
+---
+code: cpp_server_sdk_debug
+name: "Debugging and Logging"
+wikiToken: FM9CwzLh0iE4RhksFvccx5GjnHg
+parentWikiToken: YAilwkzevi8lHekvnQ9cqPnrnzh
+updateTime: 1774249328000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=cpp_server_sdk_debug
+---
+
+::: warning Notice
+The SDK Debug mode is used only for access debugging. Do not apply it to the production environment.
+:::
+During the process of SDK Integration, you can perform real-time debugging by checking SDK logs in the IDE console or using the Debug function of TE.
+## Logging
+```cpp
+TDLog::enable = true;
+```
+
+## Debugging
+You need to follow the following two steps to enable the Debug mode:
+#### Use DebugConsumer
+The sample code for enabling the Debug mode on the client side is as follows:
+```cpp
+string deviceId = "123456789";
+TDDebugConsumer debugConsumer("appId", "serverUrl", "", deviceId);
+TDAnalytics te(debugConsumer);
+
+TDPropertiesNode event_properties;
+event_properties.SetString("name", "value");
+
+te.track("accountId", "distinctId", "eventName", event_properties);
+```
+
+
+<quote-container>
+It can only be used for data verification at the integration stage, and should not be used in the online environment.
+</quote-container>

package/wiki/te-docs/raw/data-ingestion-guide/server-sdk/c/c-advanced/debugging-and-logging-RSyfw7.md

@@ -0,0 +1,41 @@
+---
+code: csharp_sdk_debug
+name: "Debugging and Logging"
+wikiToken: RSyfw7eyait7hdkCn8vcpYXHn9y
+parentWikiToken: IauKwIL6UiVIadkz8FCcBHL4n4f
+updateTime: 1774249298000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=csharp_sdk_debug
+---
+
+::: warning Notice
+The SDK Debug mode is used only for access debugging. Do not apply it to the production environment.
+:::
+During the process of SDK Integration, you can perform real-time debugging by checking SDK logs in the IDE console or using the Debug function of TE.
+## Logging
+```csharp
+TDLog.Enable = true;
+```
+
+<quote-container>
+After enabling the log, you can observe the data tracking of SDK in IDE.
+</quote-container>
+
+## Debugging
+You need to follow the following two steps to enable the Debug mode:
+#### 2.1 Use DebugConsumer
+The sample code for enabling the Debug mode on the client side is as follows:
+```csharp
+TDAnalytics te = new(new TDDebugConsumer("serverUrl", "appId", false, deviceId: "123456789"));
+Dictionary<string, object> properties= new Dictionary<string, object>();
+properties.Add("name", "test");
+
+te.Track("accountId", "distinctId", "Payment", properties);
+```
+
+#### 2.2 Add Device
+To avoid launching the Debug mode in the production environment, it is required that only specified device can enable Debug mode.  The Debug mode can only be enabled for devices whose ID has been configured in the "Debug data" sector on the "tracking management" page of the TE.
+<image token="Fd92bTTNDoSmqmx0i4ccmuQonvd" width="1280" height="590" align="center"/>
+
+<quote-container>
+It can only be used for data verification at the integration stage, and should not be used in the online environment.
+</quote-container>

package/wiki/te-docs/raw/data-ingestion-guide/server-sdk/c/c-advanced/debugging-and-logging.md

@@ -0,0 +1,89 @@
+---
+code: c_sdk_debug
+name: "Debugging and Logging"
+wikiToken: OCeRwB7Hdi9Fy7kEdtlcgo7fnDh
+parentWikiToken: IvaxwsdOwi8b3Ck84AzcXobtnDb
+updateTime: 1774249247000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=c_sdk_debug
+---
+
+::: warning Notice
+The SDK Debug mode is used only for access debugging. Do not apply it to the production environment.
+:::
+During the process of SDK Integration, you can perform real-time debugging by checking SDK logs in the IDE console or using the Debug function of TE.
+## Logging
+```c
+td_enableLog(1);
+```
+
+<quote-container>
+After enabling the log, you can observe the data tracking of SDK in IDE.
+</quote-container>
+
+## Debugging
+You need to follow the following two steps to enable the Debug mode:
+#### 2.1 Use DebugConsumer
+Build .a files with debug consumer.
+e.g. Modify the `CMakeLists.txt` file: 
+```bash
+# Debug Library: debug consumer
+if(WIN32)
+    add_compile_definitions(USE_WIN)
+    set(CMAKE_C_FLAGS "-std=c99 -pedantic-errors -m64")
+else()
+    add_compile_definitions(USE_POSIX)
+    set(CMAKE_C_FLAGS "-std=c99")
+endif()
+SET(TE_LIB_NAME thinkingDataDebug)
+add_library(${TE_LIB_NAME} src/thinkingdata.c src/td_json.c src/td_list.c src/td_util.c src/td_debug_consumer.c src/td_http_client.c)
+if(WIN32)
+    add_compile_definitions(BUILDING_LIBCURL)
+    include_directories(thirdparty/pcre/include thirdparty/curl/include)
+    link_directories(thirdparty/pcre/lib thirdparty/curl/lib)
+    target_link_libraries(${TE_LIB_NAME} pcre_x64 libcurl)
+else()
+    target_link_libraries(${TE_LIB_NAME} curl)
+endif()
+```
+
+Use debug consumer:
+```c
+struct TDAnalytics* ta = NULL;
+struct TDConsumer* consumer = NULL;
+
+TDConfig *config = td_init_config();
+
+TD_ASSERT(TD_OK == td_add_int("debug_mode", 0, config));
+
+TD_ASSERT(TD_OK == td_add_string("device_id", "123456789", strlen("123456789"), config));
+
+char* appid = "APPID";
+char* serverURL = "SERVER_URL";
+TD_ASSERT(TD_OK == td_add_string("push_url", serverURL, strlen(serverURL), config));
+TD_ASSERT(TD_OK == td_add_string("appid", appid, strlen(appid), config));
+
+if (TD_OK != td_init_consumer(&consumer, config)) {
+    fprintf(stderr, "Failed to initialize the consumer.");
+    return 1;
+}
+td_free_properties(config);
+if (TD_OK != td_init(consumer, &ta)) {
+    fprintf(stderr, "Failed to initialize the SDK.");
+    return 1;
+}
+
+TDProperties *properties = td_init_properties();
+
+TD_ASSERT(TD_OK == td_add_string("#device_id", "td_device_id", strlen("td_device_id"), properties));
+
+TD_ASSERT(TD_OK == td_track("account_id", "distinct_id", "test", properties, ta));
+td_free_properties(properties);
+```
+
+#### 2.2 Add Device
+To avoid launching the Debug mode in the production environment, it is required that only specified device can enable Debug mode.  The Debug mode can only be enabled for devices whose ID has been configured in the "Debug data" sector on the "tracking management" page of the TE.
+<image token="XRxabisN3oG9zoxiIPuc0XdHnWb" width="1280" height="590" align="center"/>
+
+<quote-container>
+It can only be used for data verification at the integration stage, and should not be used in the online environment.
+</quote-container>