document how to run dlv in headless mode and connect to the Redis CLI (#5535)

This adds two small changes to the contributing docs:

1. Instructions to connect to a local Redis REPL
2. Instructions to start `dlv` in headless mode and attach debuggers to it. I modified `.vscode/launch.json` with a new launch debug config and added instructions for vim.
This commit is contained in:
Roberto Dip 2022-05-10 11:51:09 -03:00 committed by GitHub
parent cba78bdcd1
commit 9b67736212
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 49 additions and 1 deletions

8
.vscode/launch.json vendored
View File

@ -61,6 +61,14 @@
"--dev_license"
]
},
{
"name": "Attach to a running Fleet server",
"type": "go",
"request": "attach",
"mode": "remote",
"port": 61179,
"host": "127.0.0.1",
},
{
"type": "pwa-chrome",
"name": "Fleet UI (Chrome)",

View File

@ -175,4 +175,35 @@ dlv debug --build-flags '-tags=full' ./cmd/fleet -- serve --dev
It is important to pass the `-tags=full` build flag, otherwise the server will not have access to the asset files.
<meta name="pageOrderInSection" value="100">
### Attaching a debugger to a running server
You can also run delve in headless mode, which allows you to attach your preferred debugger client and reuse the same session without having to restart the server:
```
dlv debug --build-flags '-tags=full' --headless \
--api-version=2 --accept-multiclient --continue \
--listen=127.0.0.1:61179 ./cmd/fleet -- serve --dev
```
- If you're using Visual Studio Code, there's a launch configuration in the repo.
- If you're using vim with `vimspector`, you can use the following config:
```
{
"configurations": {
"Go: Attach to Fleet server": {
"adapter": "multi-session",
"variables": {
"port": 61179,
"host": "127.0.0.1"
},
"configuration": {
"request": "attach",
"mode": "remote"
}
}
}
}
```
<meta name="pageOrderInSection" value="100">

View File

@ -9,6 +9,7 @@
- [Database backup/restore](#database-backuprestore)
- [Seeding Data](./Seeding-Data.md)
- [MySQL shell](#mysql-shell)
- [Redis REPL](#redis-repl)
- [Testing SSO](#testing-sso)
- [Testing Kinesis Logging](#testing-kinesis-logging)
@ -267,6 +268,14 @@ To connect via Docker:
docker-compose exec mysql mysql -uroot -ptoor -Dfleet
```
## Redis REPL
Connect to the `redis-cli` in REPL mode to view and interact directly with the contents stored in Redis.
```
docker-compose exec redis redis-cli
```
## Testing SSO
Fleet's `docker-compose` file includes a SAML identity provider (IdP) for testing SAML-based SSO locally.