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

Jump to bottom

Readme update #25

Open
wants to merge 4 commits into
base: readme_update
Choose a base branch
from
Open

Readme update #25

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d44771a
Merge pull request #17 from Granulate/readme_update
motisaroka Mar 11, 2024
efbe8a7
Update README.md
asaf244 Mar 12, 2024
16ae1c2
Merge pull request #19 from Granulate/asaf244-patch-1
asaf244 Mar 12, 2024
80b7210
Updating README file to properly reflect the file in the repo
Jul 30, 2024
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# About
Continuous production profiling, made easy.
Continuous production profiling, made easy (for the cloud version, which is also free, use [Intel Continuous Profiler](https://profiler.granulate.io)).

An open-source, continuous profiler for production – across any environment, at any scale.

Expand Down Expand Up @@ -84,7 +84,7 @@ The `deploy` directory contains:
- `docker-compose.yml` - The Docker compose file.
- `.env` - The environment file where you set your AWS credentials, SQS/S3 names, and AWS region.
- `https_nginx.conf` - Nginx configuration file used as an entrypoint load balancer.
- `diagnostics.sh`- A script for testing connectivity between services and printing useful information.
- `diagnostic.sh`- A script for testing connectivity between services and printing useful information.
- `tls` - A directory for storing TLS certificates (see [Securing Connections with SSL/TLS](#securing-connections-with-ssltls)).
- `.htpasswd` - A file for storing basic auth credentials (see above).

Expand Down Expand Up @@ -164,9 +164,9 @@ docker run --name granulate-gprofiler --restart=always -d --pid=host --userns=ho
```

### Diagnostics
If a service is restarted or stops, run the diagnostics.sh script to check service connectivity:
If a service is restarted or stops, run the diagnostic.sh script to check service connectivity:
```shell
./diagnostics.sh
./diagnostic.sh
```

If all OK there, take a look at the logs of the service that is not working properly.
Expand Down