Skip to content

Commit

Permalink
Update README to give correct instructions, correct negative relative…
Browse files Browse the repository at this point in the history
… time values
  • Loading branch information
nserrino committed Jul 26, 2024
1 parent 52940cd commit a9a25ed
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ This project provides a Python client for interacting with the Gimlet's control

1. Clone the repository:
```bash
git clone https://github.com/gimletlabs/metricsreader_client.git
cd metricsreader_client
git clone https://github.com/gimletlabs/metricsample.py.git
cd metricsample.py
```

2. Install the required packages:
Expand All @@ -40,15 +40,15 @@ export GML_API_KEY=your_api_key_here
``` bash
python client.py [--server_addr <server_address>] [--query <query>] [--relative <relative_time_window>]
```
- --server_addr: (Optional) The address of the gRPC server (e.g., app.gimletlabs.ai:443).
- --query: (Optional) The PromQL query string (default: gml_gem_image_quality_brisque_score).
- --relative: (Optional) The relative time window to query (default: -5m).
- `--server_addr`: (Optional) The address of the gRPC server (e.g., app.gimletlabs.ai:443).
- `--query`: (Optional) The PromQL query string (default: gml_gem_image_quality_brisque_score).
- `--relative`: (Optional) The relative time window to query (default: 5m).

### Example

``` bash
export GML_API_KEY=your_api_key_here
python client.py --server_addr app.gimletlabs.ai:443 --query "gml_gem_image_quality_brisque_score" --relative "-10m"
python client.py --server_addr app.gimletlabs.ai:443 --query "gml_gem_image_quality_brisque_score" --relative "10m"
```

## Code Overview
Expand Down
2 changes: 1 addition & 1 deletion client.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import argparse
from colored import attr, fg

def get_range_query_results(server_address, query="gml_gem_image_quality_brisque_score", relative="-5m"):
def get_range_query_results(server_address, query="gml_gem_image_quality_brisque_score", relative="5m"):
# Create SSL credentials using default trusted certificates
credentials = grpc.ssl_channel_credentials()
channel = grpc.secure_channel(server_address, credentials)
Expand Down

0 comments on commit a9a25ed

Please sign in to comment.