Skip to content

Commit

Permalink
maint: README updates prior to changing repo visibility (#211)
Browse files Browse the repository at this point in the history
## Short description of the changes

- turns on the OSS lifecycle badge for the project (⚠️ 🚨 experimental 🚨
⚠️ )
- remove outdated example event from README because we'll have accurate
example events as a product of more smoke testing soon.

## How to verify that this has the expected result

… The README looks right?

---------

Co-authored-by: Jamie Danielson <jamieedanielson@gmail.com>
  • Loading branch information
robbkidd and JamieDanielson committed Sep 19, 2023
1 parent ef65ddc commit 259eab1
Showing 1 changed file with 1 addition and 35 deletions.
36 changes: 1 addition & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Honeycomb Network Agent for Kubernetes

<!-- OSS metadata badge - rename repo link and set status in OSSMETADATA -->
<!-- [![OSS Lifecycle](https://img.shields.io/osslifecycle/honeycombio/{repo-name})](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md) -->
[![OSS Lifecycle](https://img.shields.io/osslifecycle/honeycombio/honeycomb-network-agent)](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md)

The agent is deployed to Kubernetes as a [`DaemonSet`](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/),
which means that Kubernetes will try to have the agent run on every node in the cluster.
Expand Down Expand Up @@ -70,39 +69,6 @@ Events should show up in Honeycomb in the `hny-network-agent` dataset.

Alternative options for configuration and running can be found in [Deploying the agent to a Kubernetes cluster](./DEVELOPING.md#deploying-the-agent-to-a-kubernetes-cluster):

## Example Event

```json
{
"Timestamp": "2023-08-24T19:42:17.65267Z",
"destination.address": "192.168.65.4",
"destination.k8s.pod.name": "storage-provisioner",
"destination.k8s.pod.uid": "87e44763-257b-4a52-91cc-f959292ff416",
"duration_ms": 11,
"goroutine_count": 274,
"honeycomb.agent_version": "0.0.6-alpha",
"http.method": "GET",
"http.request.body.size": 0,
"http.response.body.size": 25,
"http.status_code": 200,
"http.url": "/greeting",
"httpEvent_handled_at": "2023-08-24T19:42:18.575463885Z",
"httpEvent_handled_latency_ms": 922,
"k8s.container.name": "frontend",
"k8s.namespace.name": "greetings",
"k8s.node.name": "docker-desktop",
"k8s.node.uid": "54fe4a74-f29d-49ba-815f-a411bab8e166",
"k8s.pod.name": "frontend-go-646c6f4b7d-848xz",
"k8s.pod.uid": "faed166d-b598-48fc-b1f9-45f4bbaa92b7",
"k8s.service.name": "frontend",
"meta.btf_enabled": false,
"meta.kernel_version": "5.15.49",
"name": "HTTP GET",
"net.sock.host.addr": "10.1.3.192",
"user_agent.original": "curl/8.1.2"
}
```

## Supported Versions

- Kubernetes version 1.24+
Expand Down

0 comments on commit 259eab1

Please sign in to comment.