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

Update honeycomb docs and proto dependencies #356

Merged
merged 2 commits into from
Dec 19, 2024
Merged

Update honeycomb docs and proto dependencies #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f715c4
Update honeycomb docs.
jlewi Dec 19, 2024
3dba8a6
Update stateful dependencies to get latest version.
jlewi Dec 19, 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
18 changes: 4 additions & 14 deletions docs/content/en/docs/how-tos/honeycomb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Using Foyle and RunMe you can

## How to integrate Honeycomb with Runne

This section explains how to integrate executing Honeycomb queries from RunMe.
This section explains how to integrate executing Honeycomb queries from Runme.

Honeycomb supports embedding queries directly in the
[URL](https://docs.honeycomb.io/investigate/collaborate/share-query/). You can use this feature to define queries
Expand Down Expand Up @@ -75,20 +75,10 @@ hccli querytourl --query-file=/tmp/query3.json --base-url=https://ui.honeycomb.i

To train Foyle to be your Honeycomb you follow these steps

1. Make sure you turned on learning by following the [guide](/learning/)
1. Create a markdown cell expressing the high level intent you want to accomplish
1. Ask Foyle to generate a completion

* The first time you do this Foyle will probably provide a widely inaccurate answer because it has no prior
knowledge of your infrastructure
* Edit one of the generated code cells to contain the Honeycomb query and `hccli` command
* Execute the cell to generate the URL
1. Each time you ask for a completion and edit and execute the cell you are providing feedback to Foyle
* Foyle uses the feedback to learn and improve the completions it generates

**Important** When providing feedback to Foyle its important to do so by editing a code cell that was generated
by Foyle. If you create a new code cell Foyle won't be able to learn from it. Only cells that were generated by Foyle
are linked to the original query.
1. Create a code cell which uses `hccli` to generate the query link
1. Execute the code cell
1. Foyle automatically learns how to predict every successfully executed code cell

If you need help boostrapping some initial Honeycomb JSON queries you can use [Honeycomb's Share](https://docs.honeycomb.io/investigate/collaborate/share-query/)
feature to generate the JSON from a query constructed in the UI.
Expand Down
11 changes: 4 additions & 7 deletions protos/buf.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
# Generated by buf. DO NOT EDIT.
version: v2
deps:
- name: buf.build/bufbuild/protovalidate
commit: 3014d81c3a48461dbcc5b57536699f9e
digest: b5:04609c7e621c0aaff9164035e5c21d0d47b2af37ed58b311e15c37e9f46610255d71725a78fcca4103f2e03e2b35814667bffa146f8191693a1d502e8a0038b5
- name: buf.build/googleapis/googleapis
commit: e7f8d366f5264595bcc4cd4139af9973
digest: b5:0cd69a689ee320ed815663d57d1bc3a1d6823224a7a717d46fee3a68197c25a6f5f932c0b0e49f8370c70c247a6635969a6a54af5345cafd51e0667298768aca
commit: acd896313c55464b993332136ded1b6e
digest: b5:025d83e25193feb8dac5e5576113c8737006218b3b09fbc0d0ff652614da5424b336edb15bea139eb90d14eba656774a979d1fbdae81cbab2013932b84b98f53
- name: buf.build/stateful/runme
commit: 45813f39881a42538128c8d9757878a4
digest: b5:669c5838be7211c2fb8a663716813eb19682db4fe1dcec3e076c3aa8579d511aceb9f0ba5016294f205d7ec51bbe8e5bbc45c52bea8a1e01b6fdbc3871c43b5a
commit: 11c142f88aee4d7eaba2a77b8211f5e3
digest: b5:f2bd1c9d1288480592c4797d033b153ffaabd9b585017df64a6f256b813f0e3487dca6c9c9f4f130148dc57dc831d88e73f46828c79f37061b750988c547bc8d