docs: add support for recording STMT to CSV files

[huskar-t]

Description

docs: add support for recording STMT to CSV files

Issue(s)

• resolve: https://project.feishu.cn/taosdata_td/feature/detail/6622887611

Checklist

Please check the items in the checklist if applicable.

• Is the user manual updated?
• Are the test cases passed and automated?
• Is there no significant decrease in test coverage?

[gemini-code-assist]

Summary of Changes

Hello @huskar-t, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily updates the taosAdapter documentation to introduce a new feature that allows users to record STMT (Statement) requests to CSV files. This enhancement provides detailed logging capabilities for prepared statements, bound parameters, and execution results, which can be enabled either through a new configuration parameter or dynamically via dedicated HTTP API endpoints.

Highlights

• New STMT Recording Feature Documentation: Introduced comprehensive documentation for a new feature in taosAdapter that allows recording STMT (Statement) requests to CSV files, enhancing observability and debugging capabilities.
• Configuration Parameter: Added a new configuration parameter, log.enableStmtToCsvLogging, to enable or disable the recording of STMT requests to CSV files.
• Dynamic Control via HTTP Endpoints: Documented new HTTP endpoints (/record_stmt for POST, DELETE, GET) that allow dynamic enablement, disablement, and status querying of STMT recording tasks.
• Detailed CSV Format for STMT Records: Provided a detailed description of the CSV format for recorded STMT requests, including fields like timestamp, client IP, user, action, duration, and a structured JSON format for bind data.
• Multilingual Documentation Update: The documentation updates have been applied to both English (docs/en/) and Chinese (docs/zh/) reference manuals for taosAdapter.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

[gemini-code-assist]

Code Review

This pull request adds documentation for a new feature in taosadapter that allows recording STMT operations to CSV files. The changes include adding a new configuration parameter, its corresponding environment variable, and a detailed section explaining the feature's configuration, dynamic control via HTTP API, and data format. The documentation has been updated in both English and Chinese versions.

My review focuses on the clarity and correctness of the new documentation. I've found several areas with copy-paste errors from the existing SQL logging documentation, which could lead to confusion. These include incorrect references to 'SQL' instead of 'STMT', a typo in a filename example, and vague descriptions. I've provided suggestions to correct these inconsistencies and improve clarity.