wu-sheng commented on code in PR #13271:
URL: https://github.com/apache/skywalking/pull/13271#discussion_r2113869727
##########
docs/en/setup/backend/backend-doris-storage.md:
##########
@@ -0,0 +1,82 @@
+# Apache Doris Storage
+
+This document describes how to use Apache Doris as the storage backend for
Apache SkyWalking.
+
+## Overview
+
+Apache Doris is a real-time analytical database based on MPP architecture,
known for its high performance and ease of use. This plugin allows SkyWalking
to leverage Doris for storing its monitoring data.
+
+## Configuration
+
+To enable Apache Doris as the storage backend, you need to modify the
`application.yml` configuration file.
+
+Set the storage selector to `doris`:
+
+```yaml
+storage:
+ selector: ${SW_STORAGE:doris}
+ # Other storage options like componentScanPkg can be here if needed
+```
+
+Then, configure the specific parameters for the Doris storage provider. These
settings are typically placed under the `storage.doris` section in
`application.yml`.
+
+### Parameters
+
+The following parameters are available for the Doris storage plugin,
corresponding to the `StorageModuleDorisConfig` class:
+
+| Parameter | Type | Description |
Default Value |
+|-----------|--------|-------------------------------------------------|---------------|
+| `host` | String | The hostname or IP address of your Doris FE server. |
`localhost` (example) |
+| `port` | int | The query port of your Doris FE server. |
`9030` (example) |
+| `user` | String | The username for connecting to Doris. |
`root` (example) |
+| `password`| String | The password for the specified Doris user. |
`""` (empty) |
+| `database`| String | The database name in Doris to be used by SkyWalking. |
`skywalking` (example) |
+
+*(Note: Default values mentioned above are illustrative examples and might not
be the actual defaults in the code if not explicitly set.)*
+
+### Example Configuration
+
+Here is an example configuration block for `application.yml`:
+
+```yaml
+storage:
+ selector: ${SW_STORAGE:doris}
+ doris:
+ host: your_doris_fe_host
+ port: 9030 # Default Doris query port
+ user: your_doris_user
+ password: your_doris_password
+ database: skywalking_db
+ # Optional: Add any other relevant config parameters here if they get
added in the future
+```
+
+Make sure to replace placeholder values like `your_doris_fe_host` with your
actual Doris setup details.
+
+## Table Creation
+
+Before starting the SkyWalking OAP server with the Doris storage plugin
enabled, you must create the necessary tables and schemas in your Doris
database. SkyWalking does not automatically create these tables in Doris.
+
+The Data Definition Language (DDL) scripts for creating these tables are
provided in the SkyWalking distribution under the Doris storage plugin
directory:
+`oap-server/server-storage-plugin/storage-doris-plugin/src/main/resources/doris_schema.sql`.
Review Comment:
All storage features are all required to be implemented, including this.
Otherwise, when SkyWalking uses OAL, MAL, LAL to extend, this storage failed.
Users have to read codes and add tables on their own.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscr...@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
