Skip to content

Commit 5ca98e7

Browse files
authored
feat: update docs to point to mdbook (#20)
1 parent 122b6ce commit 5ca98e7

File tree

2 files changed

+112
-265
lines changed

2 files changed

+112
-265
lines changed

README.md

Lines changed: 8 additions & 167 deletions
Original file line numberDiff line numberDiff line change
@@ -10,178 +10,19 @@ Radar Agent connects to one or more Redis instances or deployments, collects met
1010
- Redis Enterprise clusters
1111
- OSS clusters
1212

13-
## Installation
13+
## Documentation
1414

15-
### Pre-built Binaries
15+
For complete documentation including installation, configuration, and usage instructions, please visit:
1616

17-
This document is distributed with a pre-built binary called `agent`.
17+
**[https://redis-field-engineering.github.io/radar/](https://redis-field-engineering.github.io/radar/)**
1818

19-
## Configuration
19+
## Releases
2020

21-
The agent is configured using a YAML file. By default, it looks for `agent.yaml` in the current directory, but you can specify a different file using the `--config` command-line option.
22-
23-
### Basic Configuration Example
24-
25-
```yaml
26-
agent:
27-
# Unique identifier for this agent instance
28-
id: "agent-1"
29-
# Hostname for this agent (defaults to system hostname if not specified)
30-
hostname: "redis-telemetry-node"
31-
# Key-value labels to attach to this agent
32-
labels:
33-
env: "production"
34-
region: "us-west-2"
35-
# Log level: trace, debug, info, warn, error
36-
log_level: "info"
37-
# Collection interval with time unit (s, m, h)
38-
collection_interval: "60s"
39-
40-
server:
41-
# URL of the Radar server's gRPC endpoint
42-
grpc_url: "https://grpc.radar.redis.io:443"
43-
# API key for authenticating with the Radar server
44-
api_key: "your-api-key-here"
45-
# Send interval with time unit (s, m, h)
46-
send_interval: "60s"
47-
# Maximum number of batches to queue
48-
max_batch_size: 100
49-
50-
# Redis Standalone Instance
51-
deployments:
52-
- id: "redis-prod-1"
53-
name: "Production Redis"
54-
type: "STANDALONE"
55-
redis_url: "redis://redis.example.com:6379"
56-
```
57-
58-
### Deployment Configuration
59-
60-
The agent can monitor different types of Redis deployments:
61-
62-
#### Standalone Redis Instance
63-
64-
```yaml
65-
deployments:
66-
- id: "redis-standalone"
67-
name: "Standalone Redis"
68-
type: "STANDALONE"
69-
redis_url: "redis://redis.example.com:6379"
70-
```
71-
72-
#### Redis Cluster
73-
74-
```yaml
75-
deployments:
76-
- id: "redis-cluster"
77-
name: "Redis Cluster"
78-
type: "CLUSTER"
79-
redis_urls:
80-
- "redis://redis-cluster-0.example.com:6379"
81-
- "redis://redis-cluster-1.example.com:6379"
82-
auto_discover: true
83-
```
84-
85-
#### Redis Enterprise
86-
87-
```yaml
88-
deployments:
89-
- id: "redis-enterprise"
90-
name: "Redis Enterprise"
91-
type: "ENTERPRISE"
92-
redis_url: "redis://redis-enterprise.example.com:12000"
93-
rest_api:
94-
host: "redis-enterprise.example.com"
95-
port: 9443
96-
credentials:
97-
# Redis authentication (applied to all redis_urls without auth)
98-
redis:
99-
username: "default"
100-
password: "redis_password123"
101-
# Enterprise REST API authentication
102-
enterprise_api:
103-
basic_auth: "[email protected]:password123"
104-
```
105-
106-
### Credentials and Environment Variables
107-
108-
The `credentials` section allows you to specify authentication information for Redis instances and REST APIs. You can use environment variables for sensitive information:
109-
110-
```yaml
111-
credentials:
112-
redis:
113-
username: "${REDIS_USERNAME}"
114-
password: "${REDIS_PASSWORD}"
115-
enterprise_api:
116-
basic_auth: "${REDIS_ENTERPRISE_AUTH}"
117-
cloud_api:
118-
account_key: "${REDIS_CLOUD_ACCOUNT_KEY}"
119-
user_key: "${REDIS_CLOUD_USER_KEY}"
120-
```
121-
122-
When a Redis URL doesn't include authentication, the agent will automatically apply the credentials from the `redis` section. If a Redis URL already includes authentication (e.g., `redis://user:pass@host:port`), those credentials will be preserved.
123-
124-
### Environment Variable Overrides
125-
126-
Configuration values can be overridden using environment variables:
127-
128-
```bash
129-
# Override agent ID
130-
export AGENT_AGENT_ID="custom-agent-id"
131-
132-
# Override deployment name (for the first deployment)
133-
export AGENT_DEPLOYMENTS_0_NAME="custom-deployment-name"
134-
135-
# Override server URL
136-
export AGENT_SERVER_GRPC_URL="https://new-server.example.com:50051"
137-
```
138-
139-
## Running the Agent
140-
141-
### Command Line Options
142-
143-
| Option | Env Variable | Description | Default |
144-
| ---------- | -------------- | -------------------------- | ------------ |
145-
| `--config` | `AGENT_CONFIG` | Path to configuration file | `agent.yaml` |
146-
147-
### Examples
148-
149-
```bash
150-
# Run with default configuration file
151-
agent
152-
153-
# Specify a different configuration file
154-
agent --config /path/to/custom-config.yaml
155-
```
156-
157-
### Logging
158-
159-
The log level can be configured in the configuration file or using the `RUST_LOG` environment variable:
160-
161-
```bash
162-
# Set log level to debug
163-
RUST_LOG=debug agent
164-
```
165-
166-
Available log levels: `error`, `warn`, `info`, `debug`, `trace` (from least to most verbose).
167-
168-
## Troubleshooting
169-
170-
### Common Issues
171-
172-
1. **Connection Refused**: Ensure that the Redis instance is running and accessible from the agent.
173-
2. **Authentication Failed**: Check that the credentials in your configuration are correct.
174-
3. **Server Connection Issues**: Verify that the gRPC server URL is correct and the server is running.
175-
176-
### Checking Agent Status
177-
178-
The agent logs its status to the console. You can increase the log level to get more detailed information:
179-
180-
```bash
181-
RUST_LOG=debug agent
182-
```
21+
Docker images and pre-built binaries are available from the [releases page](https://github.com/redis-field-engineering/radar-agent/releases).
18322

18423
## Support
18524

186-
For issues, questions, or feedback, please contact [email protected].
25+
For issues, questions, or feedback:
26+
- Open an issue on [GitHub](https://github.com/redis-field-engineering/radar-agent/issues)
27+
18728

0 commit comments

Comments
 (0)