Skip to content

Commit d8ad955

Browse files
Apply suggestions from code review
Co-authored-by: kirkrodrigues <[email protected]>
1 parent f3043fe commit d8ad955

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

docs/src/user-docs/guides-using-presto.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,20 @@ Using Presto with CLP requires:
4848
```yaml
4949
database:
5050
# type: "mariadb"
51-
host: <IP-address>
51+
host: "<non-local-ip-address>"
5252
# port: 3306
5353
# name: "clp-db"
5454
```
5555

5656
:::{note}
5757
This change is necessary because the Presto containers run on a Docker network, and CLP's
5858
database runs on the host network. `localhost` will refer to a different entity in each of
59-
those contexts.
59+
those contexts. This limitation will be addressed in the future when we unify Presto and CLP's
60+
deployment infrastructure.
6061
:::
6162

62-
* Set the `results_cache.retention_period` key to `null`. The CLP + Presto integration does not
63-
yet provide support for garbage collection.
63+
* Set the `results_cache.retention_period` key to `null` since the CLP + Presto integration
64+
doesn't yet support for garbage collection.
6465

6566
```yaml
6667
results_cache:
@@ -74,15 +75,19 @@ Using Presto with CLP requires:
7475
```
7576

7677
* Update the `presto` key with the host and port of the Presto cluster. If you follow the
77-
[Setting up Presto](#setting-up-presto) guide, the host is `localhost` and the port is `8889`.
78-
The Presto cluster does not need to be running to start the package.
78+
[Setting up Presto](#setting-up-presto) section, the host is `localhost` and the port is
79+
`8889`.
7980

8081
```yaml
8182
presto:
82-
host: <IP-address>
83+
host: "<ip-address>"
8384
port: <port>
8485
```
8586

87+
:::{note}
88+
Presto doesn't need to be running before you start CLP.
89+
:::
90+
8691
3. If you'd like to store your compressed logs on S3, follow the
8792
[using object storage](guides-using-object-storage/index.md) guide.
8893

@@ -166,8 +171,8 @@ docker compose rm
166171

167172
## Querying your logs through Presto
168173

169-
You can query your compressed logs in your browser from CLP’s [webUI](#querying-from-the-webui), or
170-
from the command line with the [Presto CLI](#querying-from-the-presto-cli).
174+
You can query your compressed logs in your browser from [CLP's UI](#querying-from-clps-ui), or
175+
from the command line using the [Presto CLI](#querying-from-the-presto-cli).
171176

172177
Each dataset in CLP shows up as a table in Presto. To show all available datasets:
173178

@@ -201,13 +206,13 @@ contain the field `foo.bar`, you can query it using:
201206
SELECT foo.bar FROM default LIMIT 1;
202207
```
203208

204-
### Querying from the webUI
209+
### Querying from CLP's UI
205210

206-
The CLP webUI is available at [http://localhost:4000](http://localhost:4000) (if you changed
211+
CLP's UI should be available at [http://localhost:4000](http://localhost:4000) (if you changed
207212
`webui.host` or `webui.port` in `etc/clp-config.yml`, use the new values).
208213

209214
:::{note}
210-
The WebUI can only run one query at a time, and queries must not include a `;`.
215+
The UI can only run one query at a time, and queries must not terminate with a `;`.
211216
:::
212217

213218
### Querying from the Presto CLI

0 commit comments

Comments
 (0)