Skip to content

Commit 29771d8

Browse files
authored
Update README.md
1 parent b1f02cf commit 29771d8

File tree

1 file changed

+10
-38
lines changed

1 file changed

+10
-38
lines changed

README.md

Lines changed: 10 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,17 @@
1-
# Google Cloud Pub/Sub to Better Stack
1+
# Google Cloud Pub/Sub to [Better Stack](https://betterstack.com/logs)
22

3-
A Dataflow Flex template that reads messages from Pub/Sub and sends them to Better Stack Telemetry.
3+
[![Better Stack dashboard](https://raw.githubusercontent.com/BetterStackHQ/logs-client-serilog/main/dashboard.png)](https://betterstack.com/telemetry)
44

5-
## Running the template using Web UI
5+
[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
66

7-
1. Go to Google Cloud Console -> Dataflow -> [Create job from template](https://console.cloud.google.com/dataflow/createjob)
8-
2. Choose the name and region for the Dataflow job
9-
3. Select **Custom Template**
10-
4. As Template path, use `betterstack/pubsub-to-betterstack.json`
11-
5. Set parameters based on your Google Cloud Pub/Sub Subscription and [Better Stack Telemetry source](https://telemetry.betterstack.com/team/260195/sources)
12-
6. Click **Run job**
7+
Experience SQL-compatible structured log management based on ClickHouse. [Learn more ⇗](https://betterstack.com/telemetry)
138

14-
## Running the template using CLI
9+
## Documentation
1510

16-
1. Set parameters based on your Google Cloud Pub/Sub Subscription and [Better Stack Telemetry source](https://telemetry.betterstack.com/team/260195/sources)
17-
```bash
18-
INPUT_SUBSCRIPTION=projects/$(gcloud config get-value project)/subscriptions/<your-pubsub-subscription-name>
19-
SOURCE_TOKEN=<your-better-stack-source-token>
20-
INGESTING_HOST=<your-better-stack-ingesting-host>
21-
```
22-
23-
2. Create a Dataflow job using the template
24-
```bash
25-
gcloud dataflow flex-template run "pubsub-to-betterstack-$(date +%Y%m%d-%H%M%S)" \
26-
--template-file-gcs-location=gs://betterstack/pubsub-to-betterstack.json \
27-
--parameters input_subscription=$INPUT_SUBSCRIPTION \
28-
--parameters better_stack_source_token=$SOURCE_TOKEN \
29-
--parameters better_stack_ingesting_host=$INGESTING_HOST \
30-
--region=$(gcloud config get-value compute/region)
31-
```
32-
33-
## Optional parameters
34-
35-
The template supports the following optional parameters:
36-
37-
- `batch_size`: Number of messages to batch before sending to Better Stack. Default: 100
38-
- `window_size`: Window size in seconds for batching messages. Default: 10
39-
- `max_retries`: Maximum number of retry attempts for failed requests. Uses exponential backoff between retries. Default: 3
40-
- `initial_retry_delay`: Initial delay in seconds between retries. The delay doubles with each retry attempt. Default: 1
11+
[Getting started ⇗](https://betterstack.com/docs/logs/google-cloud-pubsub/)
4112

42-
You can include these parameters in your Dataflow job in Optional Parameters section during creation in UI, or by adding them to the `gcloud dataflow flex-template run` command - e.g. `--parameters window_size=5`.
13+
## Need help?
14+
Please let us know at [[email protected]](mailto:[email protected]). We're happy to help!
4315

4416
## Releasing new version
4517

@@ -56,6 +28,6 @@ gcloud dataflow flex-template build gs://betterstack/pubsub-to-betterstack.json
5628

5729
Requires access to `betterstack` Docker Hub repository, and `betterstack` Google Cloud Bucket.
5830

59-
## License
31+
---
6032

61-
ISC License. See [LICENSE.md](LICENSE.md) for details.
33+
[ISC license](LICENSE.md)

0 commit comments

Comments
 (0)