Skip to content

add protocol support docs #824

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

Merged
merged 9 commits into from
Oct 30, 2025
Merged

add protocol support docs #824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
12fe886
add protocol support docs
NimrodAvni78 Oct 29, 2025
dac823a
Update devdocs/features.md
NimrodAvni78 Oct 30, 2025
e809a6d
Update devdocs/features.md
NimrodAvni78 Oct 30, 2025
27d8776
Update devdocs/features.md
NimrodAvni78 Oct 30, 2025
00e34cc
Update devdocs/features.md
NimrodAvni78 Oct 30, 2025
3359829
Update devdocs/features.md
NimrodAvni78 Oct 30, 2025
24d71e1
more docs
NimrodAvni78 Oct 30, 2025
73e29c2
table of contents
NimrodAvni78 Oct 30, 2025
b82cc3c
add pull_request_template
NimrodAvni78 Oct 30, 2025
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
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Checklist

- [ ] If this enhances / fixes / changes a core feature, I have updated the [features documentation](../devdocs/features.md)
8 changes: 8 additions & 0 deletions devdocs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Documentation for developers

This directory contains documentation that is not useful for our users but might be useful for developers.


### Table Of Contents

- [New Tracer](new-tracer.md): how to add a new TCP protocol based BPF tracer to OBI.
- [Pipeline Map](pipeline-map.md): explanation of pipeline map.
- [Profiling](profiling.md): how to profile OBI.
- [features](features.md): features supported by OBI.
15 changes: 15 additions & 0 deletions devdocs/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Supported Protocols

| Protocol | Languages | Versions | Methods | Secure | Propagates Context | Limitations
|:--------------|:----------:|------------:|------------------------------------------------------------------------------------------|:------:|-------------------:|--------------------------------------------------------------------------------------------------------------------:|
| HTTP | All | 1.0/1.1/2.0 | All | Yes | Yes | N/A |
| gRPC | All | 1.0+ | All | Yes | Only in Go | For non Go langagues, can't get method for long living connections, will mark method with `*` |
| MySQL | All | All | All | Yes | No | In the case of prepared statements, if the statement was prepated before OBI started then the query might be missed |
| PostgreSQL | All | All | All | Yes | No | In the case of prepared statements, if the statement was prepated before OBI started then the query might be missed |
| Redis | All | All | All | Yes | No | For already started connections, can't infer the number of the database, and won't add the `db.namespace` attribute |
| MongoDB | All | 5.0+ | insert, update, find, delete, findAndModify, aggregate, count, distinct, mapReduce | Yes | No | no support for compressed payloads |
| Kafka | All | All | produce, fetch | Yes | No | Might fail getting topic name for fetch requests in newer versions of kafka (where Fetch api version >= 13) |
| JsonRPC | Go | All | - | Yes | No | N/A |
| GraphQL | All but Go | All | All | Yes | No | N/A |
| Elasticsearch | All but Go | 7.14+ | /_search | Yes | No | N/A |
| Aws S3 | All but Go | | CreateBucket, DeleteBucket, PutObject, DeleteObject, ListBuckets, ListObjects, GetObject | Yes | No | N/A |