236 lines
12 KiB
Markdown
236 lines
12 KiB
Markdown
# Backend storage
|
|
SkyWalking storage is pluggable, we have provided the following storage solutions, you could easily
|
|
use is by changing the `application.yml`
|
|
|
|
Native supported storage
|
|
- H2
|
|
- ElasticSearch 6, 7
|
|
- MySQL
|
|
- TiDB
|
|
|
|
Redistribution version with supported storage.
|
|
- ElasticSearch 5
|
|
|
|
|
|
## H2
|
|
Active H2 as storage, set storage provider to **H2** In-Memory Databases. Default in distribution package.
|
|
Please read `Database URL Overview` in [H2 official document](http://www.h2database.com/html/features.html),
|
|
you could set the target to H2 in **Embedded**, **Server** and **Mixed** modes.
|
|
|
|
Setting fragment example
|
|
```yaml
|
|
storage:
|
|
h2:
|
|
driver: org.h2.jdbcx.JdbcDataSource
|
|
url: jdbc:h2:mem:skywalking-oap-db
|
|
user: sa
|
|
```
|
|
|
|
## ElasticSearch
|
|
- In order to activate ElasticSearch 6 as storage, set storage provider to **elasticsearch**
|
|
- In order to activate ElasticSearch 7 as storage, set storage provider to **elasticsearch7**
|
|
|
|
**Required ElasticSearch 6.3.2 or higher. HTTP RestHighLevelClient is used to connect server.**
|
|
|
|
- For ElasticSearch 6.3.2 ~ 7.0.0 (excluded), please download the `apache-skywalking-bin.tar.gz` or `apache-skywalking-bin.zip`,
|
|
- For ElasticSearch 7.0.0 ~ 8.0.0 (excluded), please download the `apache-skywalking-bin-es7.tar.gz` or `apache-skywalking-bin-es7.zip`.
|
|
|
|
For now, ElasticSearch 6 and ElasticSearch 7 share the same configurations, as follows:
|
|
|
|
Setting fragment example
|
|
|
|
```yaml
|
|
storage:
|
|
elasticsearch:
|
|
# nameSpace: ${SW_NAMESPACE:""}
|
|
# user: ${SW_ES_USER:""} # User needs to be set when Http Basic authentication is enabled
|
|
# password: ${SW_ES_PASSWORD:""} # Password to be set when Http Basic authentication is enabled
|
|
#trustStorePath: ${SW_SW_STORAGE_ES_SSL_JKS_PATH:""}
|
|
#trustStorePass: ${SW_SW_STORAGE_ES_SSL_JKS_PASS:""}
|
|
clusterNodes: ${SW_STORAGE_ES_CLUSTER_NODES:localhost:9200}
|
|
protocol: ${SW_STORAGE_ES_HTTP_PROTOCOL:"http"}
|
|
indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:2}
|
|
indexReplicasNumber: ${SW_STORAGE_ES_INDEX_REPLICAS_NUMBER:0}
|
|
# Those data TTL settings will override the same settings in core module.
|
|
recordDataTTL: ${SW_STORAGE_ES_RECORD_DATA_TTL:7} # Unit is day
|
|
otherMetricsDataTTL: ${SW_STORAGE_ES_OTHER_METRIC_DATA_TTL:45} # Unit is day
|
|
monthMetricsDataTTL: ${SW_STORAGE_ES_MONTH_METRIC_DATA_TTL:18} # Unit is month
|
|
# Batch process setting, refer to https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.5/java-docs-bulk-processor.html
|
|
bulkActions: ${SW_STORAGE_ES_BULK_ACTIONS:2000} # Execute the bulk every 2000 requests
|
|
bulkSize: ${SW_STORAGE_ES_BULK_SIZE:20} # flush the bulk every 20mb
|
|
flushInterval: ${SW_STORAGE_ES_FLUSH_INTERVAL:10} # flush the bulk every 10 seconds whatever the number of requests
|
|
concurrentRequests: ${SW_STORAGE_ES_CONCURRENT_REQUESTS:2} # the number of concurrent requests
|
|
resultWindowMaxSize: ${SW_STORAGE_ES_QUERY_MAX_WINDOW_SIZE:10000}
|
|
metadataQueryMaxSize: ${SW_STORAGE_ES_QUERY_MAX_SIZE:5000}
|
|
segmentQueryMaxSize: ${SW_STORAGE_ES_QUERY_SEGMENT_SIZE:200}
|
|
profileTaskQueryMaxSize: ${SW_STORAGE_ES_QUERY_PROFILE_TASK_SIZE:200}
|
|
advanced: ${SW_STORAGE_ES_ADVANCED:""}
|
|
```
|
|
|
|
### ElasticSearch 6 With Https SSL Encrypting communications.
|
|
|
|
example:
|
|
|
|
```yaml
|
|
storage:
|
|
elasticsearch:
|
|
# nameSpace: ${SW_NAMESPACE:""}
|
|
user: ${SW_ES_USER:""} # User needs to be set when Http Basic authentication is enabled
|
|
password: ${SW_ES_PASSWORD:""} # Password to be set when Http Basic authentication is enabled
|
|
clusterNodes: ${SW_STORAGE_ES_CLUSTER_NODES:localhost:443}
|
|
trustStorePath: ${SW_SW_STORAGE_ES_SSL_JKS_PATH:"../es_keystore.jks"}
|
|
trustStorePass: ${SW_SW_STORAGE_ES_SSL_JKS_PASS:""}
|
|
protocol: ${SW_STORAGE_ES_HTTP_PROTOCOL:"https"}
|
|
indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:2}
|
|
indexReplicasNumber: ${SW_STORAGE_ES_INDEX_REPLICAS_NUMBER:0}
|
|
# Those data TTL settings will override the same settings in core module.
|
|
recordDataTTL: ${SW_STORAGE_ES_RECORD_DATA_TTL:7} # Unit is day
|
|
otherMetricsDataTTL: ${SW_STORAGE_ES_OTHER_METRIC_DATA_TTL:45} # Unit is day
|
|
monthMetricsDataTTL: ${SW_STORAGE_ES_MONTH_METRIC_DATA_TTL:18} # Unit is month
|
|
# Batch process setting, refer to https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.5/java-docs-bulk-processor.html
|
|
bulkActions: ${SW_STORAGE_ES_BULK_ACTIONS:2000} # Execute the bulk every 2000 requests
|
|
bulkSize: ${SW_STORAGE_ES_BULK_SIZE:20} # flush the bulk every 20mb
|
|
flushInterval: ${SW_STORAGE_ES_FLUSH_INTERVAL:10} # flush the bulk every 10 seconds whatever the number of requests
|
|
concurrentRequests: ${SW_STORAGE_ES_CONCURRENT_REQUESTS:2} # the number of concurrent requests
|
|
advanced: ${SW_STORAGE_ES_ADVANCED:""}
|
|
```
|
|
|
|
|
|
### Data TTL
|
|
TTL in ElasticSearch overrides the settings of core, read [ElasticSearch section in TTL document](ttl.md#elasticsearch-6-storage-ttl)
|
|
|
|
### Advanced Configurations For Elasticsearch Index
|
|
You can add advanced configurations in `JSON` format to set `ElasticSearch index settings` by following [ElasticSearch doc](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html)
|
|
|
|
For example, set [translog](https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-translog.html) settings:
|
|
|
|
```yaml
|
|
storage:
|
|
elasticsearch:
|
|
# ......
|
|
advanced: ${SW_STORAGE_ES_ADVANCED:"{\"index.translog.durability\":\"request\",\"index.translog.sync_interval\":\"5s\"}"}
|
|
```
|
|
|
|
### Recommended ElasticSearch server-side configurations
|
|
You could add following config to `elasticsearch.yml`, set the value based on your env.
|
|
|
|
```yml
|
|
# In tracing scenario, consider to set more than this at least.
|
|
thread_pool.index.queue_size: 1000 # Only suitable for ElasticSearch 6
|
|
thread_pool.write.queue_size: 1000 # Suitable for ElasticSearch 6 and 7
|
|
|
|
# When you face query error at trace page, remember to check this.
|
|
index.max_result_window: 1000000
|
|
```
|
|
|
|
We strongly advice you to read more about these configurations from ElasticSearch official document.
|
|
This effects the performance of ElasticSearch very much.
|
|
|
|
|
|
### ElasticSearch 6 with Zipkin trace extension
|
|
This implementation shares most of `elasticsearch`, just extend to support zipkin span storage.
|
|
It has all same configs.
|
|
```yaml
|
|
storage:
|
|
zipkin-elasticsearch:
|
|
nameSpace: ${SW_NAMESPACE:""}
|
|
clusterNodes: ${SW_STORAGE_ES_CLUSTER_NODES:localhost:9200}
|
|
protocol: ${SW_STORAGE_ES_HTTP_PROTOCOL:"http"}
|
|
user: ${SW_ES_USER:""}
|
|
password: ${SW_ES_PASSWORD:""}
|
|
indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:2}
|
|
indexReplicasNumber: ${SW_STORAGE_ES_INDEX_REPLICAS_NUMBER:0}
|
|
# Those data TTL settings will override the same settings in core module.
|
|
recordDataTTL: ${SW_STORAGE_ES_RECORD_DATA_TTL:7} # Unit is day
|
|
otherMetricsDataTTL: ${SW_STORAGE_ES_OTHER_METRIC_DATA_TTL:45} # Unit is day
|
|
monthMetricsDataTTL: ${SW_STORAGE_ES_MONTH_METRIC_DATA_TTL:18} # Unit is month
|
|
# Batch process setting, refer to https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.5/java-docs-bulk-processor.html
|
|
bulkActions: ${SW_STORAGE_ES_BULK_ACTIONS:2000} # Execute the bulk every 2000 requests
|
|
bulkSize: ${SW_STORAGE_ES_BULK_SIZE:20} # flush the bulk every 20mb
|
|
flushInterval: ${SW_STORAGE_ES_FLUSH_INTERVAL:10} # flush the bulk every 10 seconds whatever the number of requests
|
|
concurrentRequests: ${SW_STORAGE_ES_CONCURRENT_REQUESTS:2} # the number of concurrent requests
|
|
```
|
|
|
|
### ElasticSearch 6 with Jaeger trace extension
|
|
This implementation shares most of `elasticsearch`, just extend to support zipkin span storage.
|
|
It has all same configs.
|
|
```yaml
|
|
storage:
|
|
jaeger-elasticsearch:
|
|
nameSpace: ${SW_NAMESPACE:""}
|
|
clusterNodes: ${SW_STORAGE_ES_CLUSTER_NODES:localhost:9200}
|
|
protocol: ${SW_STORAGE_ES_HTTP_PROTOCOL:"http"}
|
|
user: ${SW_ES_USER:""}
|
|
password: ${SW_ES_PASSWORD:""}
|
|
indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:2}
|
|
indexReplicasNumber: ${SW_STORAGE_ES_INDEX_REPLICAS_NUMBER:0}
|
|
# Those data TTL settings will override the same settings in core module.
|
|
recordDataTTL: ${SW_STORAGE_ES_RECORD_DATA_TTL:7} # Unit is day
|
|
otherMetricsDataTTL: ${SW_STORAGE_ES_OTHER_METRIC_DATA_TTL:45} # Unit is day
|
|
monthMetricsDataTTL: ${SW_STORAGE_ES_MONTH_METRIC_DATA_TTL:18} # Unit is month
|
|
# Batch process setting, refer to https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.5/java-docs-bulk-processor.html
|
|
bulkActions: ${SW_STORAGE_ES_BULK_ACTIONS:2000} # Execute the bulk every 2000 requests
|
|
bulkSize: ${SW_STORAGE_ES_BULK_SIZE:20} # flush the bulk every 20mb
|
|
flushInterval: ${SW_STORAGE_ES_FLUSH_INTERVAL:10} # flush the bulk every 10 seconds whatever the number of requests
|
|
concurrentRequests: ${SW_STORAGE_ES_CONCURRENT_REQUESTS:2} # the number of concurrent requests
|
|
```
|
|
|
|
|
|
### About Namespace
|
|
When namespace is set, names of all indexes in ElasticSearch will use it as prefix.
|
|
|
|
### About Authentication
|
|
We only support [basic authentication](https://www.elastic.co/guide/en/elasticsearch/client/java-rest/6.6/_basic_authentication.html). If you need that, you could set `user` and `password`.
|
|
For how to enable http basic authentication, you could read this https://brudtkuhl.com/blog/securing-elasticsearch/
|
|
|
|
|
|
## MySQL
|
|
Active MySQL as storage, set storage provider to **mysql**.
|
|
|
|
**NOTICE:** MySQL driver is NOT allowed in Apache official distribution and source codes.
|
|
Please download MySQL driver by yourself. Copy the connection driver jar to `oap-libs`.
|
|
|
|
```yaml
|
|
storage:
|
|
mysql:
|
|
properties:
|
|
jdbcUrl: ${SW_JDBC_URL:"jdbc:mysql://localhost:3306/swtest"}
|
|
dataSource.user: ${SW_DATA_SOURCE_USER:root}
|
|
dataSource.password: ${SW_DATA_SOURCE_PASSWORD:root@1234}
|
|
dataSource.cachePrepStmts: ${SW_DATA_SOURCE_CACHE_PREP_STMTS:true}
|
|
dataSource.prepStmtCacheSize: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_SIZE:250}
|
|
dataSource.prepStmtCacheSqlLimit: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_LIMIT:2048}
|
|
dataSource.useServerPrepStmts: ${SW_DATA_SOURCE_USE_SERVER_PREP_STMTS:true}
|
|
metadataQueryMaxSize: ${SW_STORAGE_MYSQL_QUERY_MAX_SIZE:5000}
|
|
```
|
|
All connection related settings including link url, username and password are in `application.yml`.
|
|
Here are some of the settings, please follow [HikariCP](https://github.com/brettwooldridge/HikariCP) connection pool document for all the settings.
|
|
|
|
## TiDB
|
|
Currently tested TiDB in version 2.0.9, and Mysql Client driver in version 8.0.13.
|
|
Active TiDB as storage, set storage provider to **mysql**.
|
|
|
|
```yaml
|
|
storage:
|
|
mysql:
|
|
properties:
|
|
jdbcUrl: ${SW_JDBC_URL:"jdbc:mysql://localhost:3306/swtest"}
|
|
dataSource.user: ${SW_DATA_SOURCE_USER:root}
|
|
dataSource.password: ${SW_DATA_SOURCE_PASSWORD:root@1234}
|
|
dataSource.cachePrepStmts: ${SW_DATA_SOURCE_CACHE_PREP_STMTS:true}
|
|
dataSource.prepStmtCacheSize: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_SIZE:250}
|
|
dataSource.prepStmtCacheSqlLimit: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_LIMIT:2048}
|
|
dataSource.useServerPrepStmts: ${SW_DATA_SOURCE_USE_SERVER_PREP_STMTS:true}
|
|
metadataQueryMaxSize: ${SW_STORAGE_MYSQL_QUERY_MAX_SIZE:5000}
|
|
```
|
|
All connection related settings including link url, username and password are in `application.yml`.
|
|
These settings can refer to the configuration of *MySQL* above.
|
|
|
|
## ElasticSearch 5
|
|
ElasticSearch 5 is incompatible with ElasticSearch 6 Java client jar, so it could not be included in native distribution.
|
|
[OpenSkyWalking/SkyWalking-With-Es5x-Storage](https://github.com/OpenSkywalking/SkyWalking-With-Es5x-Storage) repo includes the distribution version.
|
|
|
|
## More storage solution extension
|
|
Follow [Storage extension development guide](../../guides/storage-extention.md)
|
|
in [Project Extensions document](../../guides/README.md#project-extensions) in development guide.
|