@@ -24,10 +24,8 @@ server/config/config.toml
2424
2525DeepTrace provides several example configurations:
2626
27- - ` config .toml.example` - Basic configuration template
27+ - ` deeptrace .toml.example` - Basic configuration template
2828- ` full.toml ` - Complete configuration with all options
29- - ` production.toml ` - Production-ready configuration
30- - ` development.toml ` - Development environment settings
3129
3230## Required Configuration
3331
@@ -96,77 +94,6 @@ workers = 16
9694ip = " 0.0.0.0"
9795port = 7901
9896path = " deeptrace/ws"
99-
100- # Additional server settings
101- max_connections = 1000
102- connection_timeout = 30
103- heartbeat_interval = 10
104- ```
105-
106- ### DeepTrace Service
107-
108- ``` toml
109- # DeepTrace agent service port
110- deeptrace_port = 52001
111-
112- # Service configuration
113- [service ]
114- log_level = " info"
115- log_file = " /var/log/deeptrace/agent.log"
116- pid_file = " /var/run/deeptrace/agent.pid"
117- ```
118-
119- ### Agent Performance Settings
120-
121- ``` toml
122- [agents ]
123- # Span processing configuration
124- [agents .span ]
125- batch_size = 1024
126- flush_interval = 5
127- max_queue_size = 10000
128-
129- # Data sender configuration
130- [agents .sender ]
131- mem_buffer_size = 16 # MB
132- file_buffer_size = 32 # MB
133- file_size_limit = 1024 # MB
134- batch_size = 1024
135- compression = true
136- retry_attempts = 3
137- retry_delay = 1000 # milliseconds
138-
139- # Trace collection settings
140- [agents .trace ]
141- # Specific PIDs to monitor (empty = monitor all Docker containers)
142- pids = []
143-
144- # Process filtering
145- include_processes = [" nginx" , " redis" , " mongodb" ]
146- exclude_processes = [" systemd" , " kernel" ]
147-
148- # Protocol detection
149- auto_detect_protocols = true
150- supported_protocols = [" http" , " grpc" , " redis" , " mongodb" , " mysql" ]
151- ```
152-
153- ### API Configuration
154-
155- ``` toml
156- [agents .api ]
157- # API server settings
158- port = 7899
159- address = " 0.0.0.0"
160- workers = 1
161- ident = " deeptrace"
162-
163- # API security
164- enable_auth = false
165- api_key = " your_api_key_here"
166-
167- # Rate limiting
168- rate_limit = 1000 # requests per minute
169- burst_limit = 100
17097```
17198
17299## Advanced Configuration
@@ -274,23 +201,6 @@ ssh_port = 22
274201ssh_key_path = " /home/deeptrace/.ssh/id_rsa"
275202```
276203
277- #### TLS Configuration
278-
279- Enable TLS for secure communication:
280-
281- ``` toml
282- [server .tls ]
283- enabled = true
284- cert_file = " /etc/deeptrace/certs/server.crt"
285- key_file = " /etc/deeptrace/certs/server.key"
286- ca_file = " /etc/deeptrace/certs/ca.crt"
287-
288- [elastic .tls ]
289- enabled = true
290- verify_certificates = true
291- ca_file = " /etc/elasticsearch/certs/ca.crt"
292- ```
293-
294204## Environment Variables
295205
296206DeepTrace supports environment variable substitution in configuration files:
@@ -347,8 +257,6 @@ Error: Cannot connect to Elasticsearch at localhost:9200
347257### 1. Security
348258
349259- ** Use environment variables** for sensitive information
350- - ** Enable TLS** for production deployments
351- - ** Use SSH keys** instead of passwords
352260- ** Restrict network access** to DeepTrace ports
353261
354262### 2. Performance
@@ -372,75 +280,6 @@ Error: Cannot connect to Elasticsearch at localhost:9200
372280- ** Test configuration changes** in development first
373281- ** Keep backups** of working configurations
374282
375- ## Configuration Templates
376-
377- ### Small Deployment (1-5 hosts)
378-
379- ``` toml
380- [server ]
381- ip = " 192.168.1.100"
382- port = 7901
383-
384- [elastic ]
385- elastic_password = " simple_password"
386- bulk_size = 512
387-
388- [[agents .agent_info ]]
389- agent_name = " small-deployment"
390- user_name = " ubuntu"
391- host_ip = " 192.168.1.101"
392- ssh_port = 22
393- host_password = " password"
394- workers = 4
395-
396- [agents .sender ]
397- batch_size = 512
398- mem_buffer_size = 16
399- ```
400-
401- ### Medium Deployment (5-20 hosts)
402-
403- ``` toml
404- [server ]
405- ip = " deeptrace.internal.com"
406- port = 7901
407-
408- [elastic ]
409- elastic_password = " ${ELASTIC_PASSWORD}"
410- bulk_size = 1024
411- request_timeout = 20
412-
413- # Multiple agents configuration...
414- [agents .sender ]
415- batch_size = 1024
416- mem_buffer_size = 32
417- compression = true
418- ```
419-
420- ### Large Deployment (20+ hosts)
421-
422- ``` toml
423- [server ]
424- ip = " deeptrace-cluster.company.com"
425- port = 7901
426- max_connections = 5000
427-
428- [elastic ]
429- elastic_password = " ${ELASTIC_PASSWORD}"
430- bulk_size = 2048
431- request_timeout = 30
432-
433- [agents .sender ]
434- batch_size = 2048
435- mem_buffer_size = 64
436- file_buffer_size = 128
437- compression = true
438-
439- [logging ]
440- level = " warn"
441- file = " /var/log/deeptrace/production.log"
442- ```
443-
444283## Troubleshooting Configuration
445284
446285### Common Issues
@@ -476,8 +315,4 @@ After configuring DeepTrace:
476315
4773161 . ** [ All-in-One Deployment] ( ./all-in-one.md ) ** : Deploy for testing
4783172 . ** [ Basic Usage] ( ../user-guide/basic-usage.md ) ** : Start using DeepTrace
479- 3 . ** [ Troubleshooting] ( ../troubleshooting/common-issues.md ) ** : Resolve issues
480-
481- ---
482-
483- Proper configuration is crucial for DeepTrace's performance and reliability. Take time to understand each setting and adjust them according to your specific requirements and environment.
318+ 3 . ** [ Troubleshooting] ( ../troubleshooting/common-issues.md ) ** : Resolve issues
0 commit comments