mirror of
https://github.com/rustfs/rustfs.git
synced 2026-07-27 08:38:58 +00:00
houseme
4795638763
- Add obs_config parameter to config struct with default path - Document how to modify use_stdout value in README.md - Support configuring observability via file or environment variables This change helps users configure telemetry output destination for better observability options in different deployment scenarios.
95 lines
2.6 KiB
Markdown
95 lines
2.6 KiB
Markdown
# How to compile RustFS
|
|
|
|
| Must package | Version |
|
|
|--------------|---------|
|
|
| Rust | 1.8.5 |
|
|
| protoc | 27.0 |
|
|
| flatc | 24.0+ |
|
|
|
|
Download Links:
|
|
|
|
https://github.com/google/flatbuffers/releases/download/v24.3.25/Linux.flatc.binary.g++-13.zip
|
|
|
|
https://github.com/protocolbuffers/protobuf/releases/download/v27.0/protoc-27.0-linux-x86_64.zip
|
|
|
|
Or use Docker:
|
|
|
|
- uses: arduino/setup-protoc@v3
|
|
with:
|
|
version: "27.0"
|
|
|
|
- uses: Nugine/setup-flatc@v1
|
|
with:
|
|
version: "24.3.25"
|
|
|
|
# How to add Console web
|
|
|
|
1. wget [http://dl.rustfs.com/console/console.latest.tar.gz](https://dl.rustfs.com/console/rustfs-console-latest.zip)
|
|
|
|
2. mkdir in this repos folder `./rustfs/static`
|
|
|
|
3. Compile RustFS
|
|
|
|
# Star RustFS
|
|
|
|
Add Env infomation:
|
|
|
|
```
|
|
export RUST_LOG="rustfs=debug,ecstore=debug,s3s=debug,iam=debug"
|
|
export RUSTFS_VOLUMES="./target/volume/test"
|
|
export RUSTFS_ADDRESS="0.0.0.0:9000"
|
|
export RUSTFS_CONSOLE_ENABLE=true
|
|
export RUSTFS_CONSOLE_ADDRESS="0.0.0.0:9001"
|
|
export RUSTFS_OBS_CONFIG="config/obs.toml"
|
|
```
|
|
|
|
You need replace your real data folder:
|
|
|
|
```
|
|
./rustfs /data/rustfs
|
|
```
|
|
|
|
## How to deploy the observability stack
|
|
|
|
The OpenTelemetry Collector offers a vendor-agnostic implementation on how to receive, process, and export telemetry
|
|
data. It removes the need to run, operate, and maintain multiple agents/collectors in order to support open-source
|
|
observability data formats (e.g. Jaeger, Prometheus, etc.) sending to one or more open-source or commercial back-ends.
|
|
|
|
1. Enter the `.docker/observability` directory,
|
|
2. Run the following command:
|
|
|
|
```bash
|
|
docker-compose -f docker-compose.yml up -d
|
|
```
|
|
|
|
3. Access the Grafana dashboard by navigating to `http://localhost:3000` in your browser. The default username and
|
|
password are `admin` and `admin`, respectively.
|
|
|
|
4. Access the Jaeger dashboard by navigating to `http://localhost:16686` in your browser.
|
|
|
|
5. Access the Prometheus dashboard by navigating to `http://localhost:9090` in your browser.
|
|
|
|
## Create a new Observability configuration file
|
|
|
|
#### 1. Enter the `config` directory,
|
|
|
|
#### 2. Copy `obs.toml.example` to `obs.toml`
|
|
|
|
#### 3. Modify the `obs.toml` configuration file
|
|
|
|
##### 3.1. Modify the `endpoint` value to the address of the OpenTelemetry Collector
|
|
|
|
##### 3.2. Modify the `service_name` value to the name of the service
|
|
|
|
##### 3.3. Modify the `service_version` value to the version of the service
|
|
|
|
##### 3.4. Modify the `deployment_environment` value to the environment of the service
|
|
|
|
##### 3.5. Modify the `meter_interval` value to export interval
|
|
|
|
##### 3.6. Modify the `sample_ratio` value to the sample ratio
|
|
|
|
##### 3.7. Modify the `use_stdout` value to export to stdout
|
|
|
|
|