Skip to content

Commit

Permalink
corrected typo and added links to user guide in README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Ravi Anne <[email protected]>
  • Loading branch information
Ravi Anne committed Jul 18, 2024
1 parent 56aa0e4 commit eb94fde
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions Monocle_User_Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,18 +108,18 @@ Monocle generates spans which adhere to [Tracing API | OpenTelemetry](https://op
| &ensp; "```span_id```": "0x30b13075eca52f44",||
| &ensp; "```trace_state```": "[]"||
| &ensp; },||
|"```kind```": "SpanKind.INTERNAL",| An enum that describes what this span is about. Default value is SpanKind.INTERNAL, as current enums do not cover ML apps |
|"```parent_id```": null,|If null, this is root span|
|"```kind```": "SpanKind.INTERNAL",| an enum that describes what this span is about. Default value is SpanKind.INTERNAL, as current enums do not cover ML apps |
|"```parent_id```": null,|if null, this is root span|
|"```start_time```": "2024-07-16T17:05:15.544861Z",||
|"```end_time```": "2024-07-16T17:05:43.502007Z",||
|"```status```": {||
|&ensp; "```status_code```": "UNSET"| This to be updated to set to OK or ERROR. Default is UNSET|
|&ensp; "```status_code```": "UNSET"| status of span to OK or ERROR. Default is UNSET|
|&ensp; },||
|"```attributes```": {||
|&ensp; "workflow_name": "ml_rag_app",|defines the name of the service being set in ```setup_okahu_telemetry(...)``` during initialization of instrumentation|
|&ensp; "workflow_type": "workflow.langchain"|type of framework that generated this span|
|&ensp; },||
|"```events```": [|Captures the log records|
|"```events```": [|captures the log records|
|&ensp; {||
|&ensp;&emsp; "```name```": "input",|name of the event. If the span is about LLM, then this will be 'input'. For vector store retrieval, this would be 'context_input'|
|&ensp;&emsp; "```timestamp```": "2024-07-16T17:05:15.544874Z",||
Expand All @@ -136,11 +136,11 @@ Monocle generates spans which adhere to [Tracing API | OpenTelemetry](https://op
|&emsp;&emsp;&emsp;}||
|&emsp;&emsp;}||
|&emsp; ],||
|&emsp; "```links```": [],|unpopulated and unused|
|&emsp; "```links```": [],|unused. Ideally this links other causally-related spans,<br/> but as spans are grouped by ```trace_id```, and ```parent_id``` links to parent span, this is unused|
|&emsp; "```resource```": {|represents the service name or server or machine or container which generated the span|
|&emsp;&emsp;&emsp; "```attributes```": {||
|&emsp;&emsp;&emsp;&emsp; "service.name": "ml_rag_app"|only service.name is being populated and defaults to the value of 'workflow_name' |
|&emsp;&emsp;&emsp; },||
|&emsp;&emsp;"```schema_url```": ""|unpopulated and unused|
|&emsp;&emsp;"```schema_url```": ""|unused|
|&emsp;&emsp; }||
|} | |
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ The traces are compatible with OpenTelemetry format. They are further enriched t
```
setup_okahu_telemetry(workflow_name="your-app-name")
```
Please refer to Monocle user guide for more details
Please refer to [Monocle user guide](Monocle_User_Guide.md) for more details

## Get involved
### Provide feedback
- Submit issues and enhancements requests via Github issues

### Contribute
- Monocle is community based open source project. We welcome your contributions. Please refer to the CONTRIBUTING and CODE_OF_CONDUCT for guidelines. The contributor's guide provides technical details of the project.
- Monocle is community based open source project. We welcome your contributions. Please refer to the CONTRIBUTING and CODE_OF_CONDUCT for guidelines. The [contributor's guide](CONTRIBUTING.md) provides technical details of the project.

0 comments on commit eb94fde

Please sign in to comment.