Skip to content

Commit

Permalink
Updates beacon agent on-prem DSN examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ksnavely authored and djw-m committed Nov 6, 2024
1 parent bfcb5aa commit 50e7b20
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ beacon-agent [subcommand] [options]

#### Description

Runs the Beacon agent.
Runs the Beacon agent.

In default mode, with no subcommand, this runs the Beacon Agent process, which sends data ingestions to the Beacon Server and maintains a local log of its activities.

Expand All @@ -53,7 +53,7 @@ beacon-agent [-file=<configurationfilepath>]
Start Beacon Agent:

```
beacon-agent
beacon-agent
```

### `setup`
Expand Down Expand Up @@ -81,17 +81,17 @@ beacon-agent setup [-file=<configurationfilepath>]
|---------------------|---------------------------------------------------------------------------------------------------|
| `-file=<string>` | Sets the filename (and path) of the generated configuration file. (default `"beacon_agent.yaml"`) |
| `-verify=<boolean>` | Verifies the project's credentials with the Beacon server. |

#### Examples

##### Creating a configuration file, without authentication

```
beacon-agent setup -verify=false
```

##### Creating a configuration file with a different name

```
beacon-agent setup -file my_beacon_config.yaml
```
Expand Down Expand Up @@ -158,8 +158,7 @@ agent:
provider:
onprem:
databases:
sales_reporting:
dsn: "$DSN"
- dsn: "$DSN"
tags:
- "foo"
- "bar"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Before you begin, you need to have the following:

You need to enable the system you are planning on running the agent on to download packages from the EDB repositories for EDB Postgres AI.

Locate your EDB subscription token on the the [EnterpriseDB repos download page](https://www.enterprisedb.com/repos-downloads).
Locate your EDB subscription token on the the [EnterpriseDB repos download page](https://www.enterprisedb.com/repos-downloads).

Using the retrieved subscription token, set an environmental variables (`EDB_SUBSCRIPTION_TOKEN`) to the token's value. Also set an environmental variable for your EDB subscription type (`EDB_SUBSCRIPTION_TYPE`) to one of `standard` or `enterprise` depending on which plan you are signed up to:

Expand Down Expand Up @@ -84,7 +84,7 @@ export BEACON_AGENT_PROJECT_ID=<your-project-id>

Running the `beacon-agent setup` command creates a configuration file in the Beacon configuration directory. using those environment variables.

You also need to specify the Beacon configuration directory for storing the configuration file and the name of the configuration file to generate there. The `$HOME/.beacon/` file is one of the default locations which `beacon_agent` searches for `beacon_agent.yaml` when it starts. Using the `-file` flag tells the agent setup process to create its configuration file in a specific location.
You also need to specify the Beacon configuration directory for storing the configuration file and the name of the configuration file to generate there. The `$HOME/.beacon/` file is one of the default locations which `beacon_agent` searches for `beacon_agent.yaml` when it starts. Using the `-file` flag tells the agent setup process to create its configuration file in a specific location.

```
beacon-agent setup -file="$HOME/.beacon/beacon_agent.yaml"
Expand Down Expand Up @@ -114,16 +114,14 @@ Entries under `databases` utilize the following format:

```yaml
databases:
<database_name_1>:
dsn: "$DSN1"
tags:
- "<tag-one>"
- "<tag-two>"
<database_name_2>:
dsn: "$DSN2"
tags:
- "<tag-one>"
- "<tag-two>"
- dsn: "$DSN1"
tags:
- "<tag-one>"
- "<tag-two>"
- dsn: "$DSN2"
tags:
- "<tag-one>"
- "<tag-two>"
```
Here is an example `beacon_agent.yaml` file configured for a database named `sales_reporting`:
Expand All @@ -141,12 +139,11 @@ agent:
- "onprem"
provider:
onprem:
databases:
sales_reporting:
dsn: "$DSN"
databases:
- dsn: “$DSN”
tags:
- "sales"
- "reports"
- "sales"
- "reports"
host:
resource_id: "postgresql.lan"
tags: []
Expand Down

0 comments on commit 50e7b20

Please sign in to comment.