Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistent header levels in readme #212

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Consistent header levels in readme #212

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ This plugin is used to obtain information about a Heroku Postgres instance,
that may be useful when analyzing performance issues. This includes information
about locks, index usage, buffer cache hit ratios and vacuum statistics.

### Installation
## Installation

```bash
$ heroku plugins:install heroku-pg-extras
```

### Usage
## Usage
Comment on lines -9 to +15
Copy link
Author

@jmanian jmanian Oct 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This puts these at the same header level as "Publishing" and the beta note at the bottom (H2), and makes them one level below the title at the top (which is H1), and allows the commands to all use H3, which is what most of them already are.


Each command can display more detailed usage information, including accepted flags, with `heroku help pg:<command>`.

#### `pg:cache-hit`
### `pg:cache-hit`

```bash
$ heroku pg:cache-hit
Expand All @@ -29,7 +29,7 @@ $ heroku pg:cache-hit

This command provides information on the efficiency of the buffer cache, for both index reads (`index hit rate`) as well as table reads (`table hit rate`). A low buffer cache hit ratio can be a sign that the Heroku Postgres plan is too small for the workload.

#### `pg:index-usage`
### `pg:index-usage`

```
$ heroku pg:index-usage
Expand Down Expand Up @@ -118,7 +118,7 @@ $ heroku pg:blocking

This command displays statements that are currently holding locks that other statements are waiting to be released. This can be used in conjunction with `pg:locks` to determine which statements need to be terminated in order to resolve lock contention.

#### `pg:total-index-size`
### `pg:total-index-size`

```
$ heroku pg:total-index-size
Expand Down