Skip to content

Commit a02f20f

Browse files
chore: rename URLs and email addresses (#91)
Signed-off-by: Patrick Stephens <pat@fluent.do>
1 parent a95334a commit a02f20f

File tree

13 files changed

+58
-38
lines changed

13 files changed

+58
-38
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# documentation
22

3-
This repo contains the docs provided by <https://docs.fluent.do>.
3+
This repo contains the docs provided by <https://docs.telemetryforge.io>.
44
Documentation is generated via `mkdocs` and hosted in Vercel.
55

66
## Security reporting

docs/build-optimisations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ set(CMAKE_C_FLAGS "${SAVED_CMAKE_C_FLAGS}")
5353
## Size Impact
5454

5555
| Metric | OSS Fluent Bit | Telemetry Forge Agent | Reduction |
56-
|--------|---------------|----------------|-----------|
56+
| ------ | -------------- | --------------------- | --------- |
5757
| Docker Image Size | ~500MB | ~150MB | ~70% |
5858
| Binary Size | ~50-60MB | ~15-20MB | ~67% |
5959
| Memory Usage | ~50-70MB RSS | ~20-30MB RSS | ~57% |

docs/features/git-config-auto-reload.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,25 @@ The plugin also exposes Prometheus-compatible metrics for monitoring repository
1717
## Configuration Options
1818

1919
| Parameter | Type | Required | Default | Description |
20-
|-----------|------|----------|---------|-------------|
20+
| --------- | ---- | -------- | ------- | ----------- |
2121
| `repo` | String | Yes | - | Git repository URL (HTTPS, SSH, or file://) |
2222
| `ref` | String | No | `main` | Git reference: branch name, tag, or commit SHA |
2323
| `path` | String | Yes | - | Path to configuration file within the repository |
2424
| `clone_path` | String | No | `/tmp/fluentbit-git-repo` | Local directory for git clone and state storage |
2525
| `poll_interval` | Integer | No | `60` | Polling interval in seconds to check for updates |
2626

27-
2827
The Git repository URL. Supports multiple protocols:
2928

3029
- **HTTPS**: `https://github.com/user/repo.git`
3130
- **SSH**: `git@github.com:user/repo.git`
3231
- **Local file**: `file:///path/to/repo`
3332

3433
For private repositories:
34+
3535
- **HTTPS**: Use personal access tokens in the URL: `https://token@github.com/user/repo.git`
3636
- **SSH**: Configure SSH keys in `~/.ssh/` (requires `id_rsa` or `id_ed25519`)
3737

38-
#### `ref`
38+
### `ref`
3939

4040
The Git reference to track. Can be:
4141

@@ -50,13 +50,15 @@ The plugin monitors this reference for changes. When the commit SHA at this ref
5050
Path to the configuration file within the repository, relative to the repository root.
5151

5252
Examples:
53+
5354
- `fluent-bit.yaml`
5455
- `config/production.yaml`
5556
- `environments/prod/fluent-bit.conf`
5657

5758
#### `clone_path`
5859

5960
Local directory where:
61+
6062
- The Git repository is cloned
6163
- SHA-based configuration files are stored
6264
- The state file (`.last_sha`) is stored
@@ -68,6 +70,7 @@ The directory will be created if it doesn't exist. Must be writable by the Fluen
6870
How frequently (in seconds) to check the remote repository for changes.
6971

7072
Recommended values:
73+
7174
- **Development/Testing**: 5-10 seconds
7275
- **Production**: 60-300 seconds
7376

@@ -155,11 +158,13 @@ pipeline:
155158
### State Persistence
156159

157160
The plugin stores the last processed commit SHA in a state file:
158-
```
161+
162+
```shell
159163
{clone_path}/.last_sha
160164
```
161165

162166
This state file:
167+
163168
- Persists across Fluent Bit restarts
164169
- Prevents unnecessary reloads when restarting with unchanged configuration
165170
- Contains a 40-character SHA-1 commit hash
@@ -178,11 +183,13 @@ When a configuration change is detected:
178183
### Change Detection
179184

180185
The plugin uses Git commit SHAs for change detection:
186+
181187
- Fetches the commit SHA at the specified `ref`
182188
- Compares with the last processed SHA from state file
183189
- If different, triggers sync and reload
184190

185191
This approach works with:
192+
186193
- Branch updates (SHA changes when new commits are pushed)
187194
- Tag updates (if tag is moved to a different commit)
188195
- Direct SHA monitoring (only reloads if you manually update the `ref` parameter)
@@ -194,7 +201,7 @@ The plugin exposes Prometheus-compatible metrics for monitoring repository polli
194201
### Available Metrics
195202

196203
| Metric | Type | Labels | Description |
197-
|--------|------|--------|-------------|
204+
| ------ | ---- | ------ | ----------- |
198205
| `fluentbit_git_config_last_poll_timestamp_seconds` | Gauge | `name` | Unix timestamp of the last repository poll |
199206
| `fluentbit_git_config_last_reload_timestamp_seconds` | Gauge | `name` | Unix timestamp of the last configuration reload |
200207
| `fluentbit_git_config_poll_errors_total` | Counter | `name` | Total number of repository poll errors |
@@ -210,7 +217,8 @@ curl http://localhost:2020/api/v1/metrics/prometheus
210217
```
211218

212219
Example output:
213-
```
220+
221+
```text
214222
# HELP fluentbit_git_config_last_poll_timestamp_seconds Unix timestamp of last repository poll
215223
# TYPE fluentbit_git_config_last_poll_timestamp_seconds gauge
216224
fluentbit_git_config_last_poll_timestamp_seconds{name="git_config.0"} 1696349234
@@ -237,6 +245,7 @@ fluentbit_git_config_info{sha="abc123def",repo="https://github.com/myorg/configs
237245
You can use these metrics with monitoring systems like Prometheus and Grafana:
238246

239247
**Prometheus Alert Examples:**
248+
240249
```yaml
241250
groups:
242251
- name: fluent_bit_git_config
@@ -301,6 +310,7 @@ customs:
301310
```
302311

303312
Requirements:
313+
304314
- SSH keys configured in `~/.ssh/id_rsa` or `~/.ssh/id_ed25519`
305315
- Proper permissions: `chmod 600 ~/.ssh/id_rsa`
306316
- Known hosts configured: `ssh-keyscan github.com >> ~/.ssh/known_hosts`
@@ -322,6 +332,7 @@ The plugin is designed to be resilient to transient errors:
322332
- **Too infrequent**: Delays detection of configuration changes
323333

324334
Choose based on your requirements:
335+
325336
- Critical production systems: 60-120 seconds
326337
- Active development: 5-10 seconds
327338
- Stable environments: 300-600 seconds
@@ -335,16 +346,17 @@ Choose based on your requirements:
335346
### Repository Size
336347

337348
Large repositories with extensive history may slow initial cloning. Consider:
349+
338350
- Using shallow clones (future enhancement)
339351
- Keeping configuration repositories small and focused
340352
- Using separate repositories for configuration vs. application code
341353

342354
## Troubleshooting
343355

344-
345356
### Authentication Failures
346357

347358
For SSH:
359+
348360
```bash
349361
# Test SSH connection
350362
ssh -T git@github.com
@@ -355,6 +367,7 @@ chmod 600 ~/.ssh/id_rsa
355367
```
356368

357369
For HTTPS with token:
370+
358371
```bash
359372
# Test git access
360373
git ls-remote https://token@github.com/user/repo.git
@@ -363,12 +376,14 @@ git ls-remote https://token@github.com/user/repo.git
363376
### Changes Not Detected
364377

365378
Enable debug logging to see polling activity:
379+
366380
```yaml
367381
service:
368382
log_level: debug
369383
```
370384

371385
Check:
386+
372387
- Remote repository actually has new commits
373388
- `ref` points to the branch/tag you expect
374389
- Polling interval hasn't elapsed yet
@@ -378,6 +393,7 @@ Check:
378393
### Reload Failures
379394

380395
Check:
396+
381397
- Configuration file syntax is valid
382398
- All referenced plugins are available
383399
- File paths and permissions are correct
@@ -386,11 +402,13 @@ Check:
386402
### High Error Rates
387403

388404
Monitor the error metrics:
405+
389406
```bash
390407
curl -s http://localhost:2020/api/v1/metrics/prometheus | grep -E "git_config_(poll|sync)_errors"
391408
```
392409

393410
Common causes:
411+
394412
- Network connectivity issues
395413
- Authentication failures
396414
- Repository access problems

docs/features/record-deduplication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ The processor uses bloom filters and hash indexing to minimize disk I/O, ensurin
142142
### Prometheus Metrics
143143

144144
| Metric Name | Type | Description |
145-
|-------------|------|-------------|
145+
| ----------- | ---- | ----------- |
146146
| `fluentbit_processor_dedup_records_processed_total` | Counter | Total number of records processed by the deduplication processor |
147147
| `fluentbit_processor_dedup_records_removed_total` | Counter | Total number of duplicate records removed |
148148
| `fluentbit_processor_dedup_records_kept_total` | Counter | Total number of unique records kept |

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,4 +97,4 @@ Our Agent is **70% smaller than OSS Fluent Bit** through:
9797

9898
### Contact
9999

100-
For custom builds, white-label solutions, or enterprise support: **<info@fluent.do>**
100+
For custom builds, white-label solutions, or enterprise support: **<info@telemetryforge.io>**

docs/security.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ uid [ultimate] FluentDo <info@fluent.do>
5656
sub cv25519 2025-11-28 [E] [expires: 2028-11-27]
5757
```
5858

59+
Note: FluentDo was the original name before rebranding as Telemetry Forge.
60+
5961
In addition we generate `sha256` checksums for all packages and sign those files as well for all targets.
6062

6163
This information is for releases `v25.12` and `v25.10.8` onwards, for earlier releases please contact us.
@@ -69,7 +71,7 @@ We provide triaged CVE reports both as a [web page](./security/triaged.md) or a
6971
The VEX endpoint can be downloaded and used like so:
7072

7173
```shell
72-
curl -sSfLO https://docs.fluent.do/security/vex.json
74+
curl -sSfLO https://docs.telemetryforge.io/security/vex.json
7375
trivy image fluent/fluent-bit:4.0.9 --vex vex.json
7476
grype fluent/fluent-bit:4.0.9 --vex vex.json
7577
```

docs/security/cves.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This page hosts all known information about any security issues, mitigations and triaged CVEs.
44

5-
Please reach out to us at <info@fluent.do> directly for any specific concerns or queries.
5+
Please reach out to us at <info@telemetryforge.io> directly for any specific concerns or queries.
66

77
--8<-- "docs/security/triaged.md"
88

docs/security/triaged/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Using CVE-2023-2953 as an example, we do the following:
1616
vexctl create --product="pkg:oci/fluent-bit" \
1717
--vuln="CVE-2023-2953" \
1818
--status="under_investigation" \
19-
--author="info@fluent.do" \
19+
--author="info@telemetryforge.io" \
2020
| tee investigation.vex.json
2121
```
2222

@@ -29,7 +29,7 @@ Using CVE-2023-2953 as an example, we do the following:
2929
--vuln="CVE-2023-2953" \
3030
--status="not_affected" \
3131
--justification="vulnerable_code_not_in_execute_path" \
32-
--author="info@fluent.do" \
32+
--author="info@telemetryforge.io" \
3333
--impact-statement="Fluent Bit does not use this component directly or in the way affected in the CVE." \
3434
| tee triaged.vex.json
3535
```
@@ -51,7 +51,7 @@ The generation process will loop through all CVE directories and merge any VEX f
5151

5252
```shell
5353
cd docs/security/triaged/CVE-2023-2953
54-
vexctl merge --author="info@fluent.do" \
54+
vexctl merge --author="info@telemetryforge.io" \
5555
investigation.vex.json \
5656
triaged.vex.json | tee vex.json
5757
```

docs/security/vex.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"@context": "https://openvex.dev/ns/v0.2.0",
33
"@id": "merged-vex-681248f4fa4785dbdea36f4da98fc053a78f65a9ec3c68e3acb19ae133adb244",
4-
"author": "info@fluent.do",
4+
"author": "info@telemetryforge.io",
55
"timestamp": "2025-09-05T14:21:45.108287698+01:00",
66
"version": 1,
77
"statements": [

docs/supported-platforms.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Our Agent supports all major architectures including `x86_64` and `arm64` as wel
44

55
Releases can be found or watched here: <https://github.com/telemetryforge/agent>
66

7-
Packages are available via [https://packages.fluent.do](https://packages.fluent.do/index.html).
7+
Packages are available via [https://packages.telemetryforge.io](https://packages.telemetryforge.io/index.html).
88

9-
Please [contact us](mailto:info@fluent.do) for full details.
9+
Please [contact us](mailto:info@telemetryforge.io) for full details.
1010

1111
## Kubernetes versions
1212

@@ -33,23 +33,23 @@ Hardened container images are provided for:
3333

3434
Packages as well as public VM images (or AMIs) are available for the following Enterprise OS Versions:
3535

36-
|OS | Versions Supported | Notes |
37-
|---|--------------------|-------|
38-
|RHEL|7.x, 8.x, 9.x, 10.x|RHEL compatibility via CentOS 7 then Alma Linux 8-10. |
39-
|CentOS|6.x, 7.x||
40-
|CentOS Stream|8, 9, 10|Upstream dependencies no longer guaranteed to be RHEL-compatible.|
41-
|Alma Linux| 8, 9, 10| RHEL–compatible without breaking changes from CentOS stream. |
42-
|Rocky Linux| 8, 9, 10| RHEL–compatible without breaking changes from CentOS stream. |
43-
|SUSE Linux Enterprise Server (SLES)|12, 15||
44-
|Ubuntu LTS|18.04, 20.04, 22.04, 24.04||
45-
|Debian|10,11,12,13||
46-
|Mariner/Azure Linux|2,3||
47-
|Amazon Linux|2023||
48-
|Windows|2022,2025| Server versions but compatible with desktop equivalents |
49-
|macOS|14,15|Apple and Intel Silicon|
36+
| OS | Versions Supported | Notes |
37+
| -- | ------------------ | ----- |
38+
| RHEL | 7.x, 8.x, 9.x, 10.x | RHEL compatibility via CentOS 7 then Alma Linux 8-10. |
39+
| CentOS | 6.x, 7.x | |
40+
| CentOS Stream | 8, 9, 10 | Upstream dependencies no longer guaranteed to be RHEL-compatible. |
41+
| Alma Linux | 8, 9, 10 | RHEL–compatible without breaking changes from CentOS stream. |
42+
| Rocky Linux | 8, 9, 10 | RHEL–compatible without breaking changes from CentOS stream. |
43+
| SUSE Linux Enterprise Server (SLES) | 12, 15 | |
44+
| Ubuntu LTS | 18.04, 20.04, 22.04, 24.04 | |
45+
| Debian | 10,11,12,13 | |
46+
| Mariner/Azure Linux | 2,3 | |
47+
| Amazon Linux | 2023 | |
48+
| Windows | 2022,2025 | Server versions but compatible with desktop equivalents |
49+
| macOS | 14,15 | Apple and Intel Silicon |
5050

5151
ARM64 and AMD64 variants are provided where applicable.
5252

5353
Part of our support package includes testing against the specific use cases or configurations you may require.
5454

55-
Installation of packages is available via [https://packages.fluent.do](https://packages.fluent.do/index.html).
55+
Installation of packages is available via [https://packages.telemetryforge.io](https://packages.telemetryforge.io/index.html).

0 commit comments

Comments
 (0)