Skip to content

Update Documentation for Inference Logging with Annotation Injection #458

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Documentation for Inference Logging with Annotation Injection #458

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions docs/modelserving/logger/logger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,34 @@ predictor:
storageUri: gs://kfserving-examples/models/sklearn/1.0/model
```

## Inference Logger with Inference Service Annotation

The inference service annotations can be included in the log message by specifying the annotation keys in the `metadataAnnotations` field
of the InferenceService CRD. These annotations are included in the CloudEvent extension attribute `annotations`.
Copy link
Member

@yuzisun yuzisun Apr 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tylerhyang Can you provide an example cloud event showing the extension attribute ?


```yaml
apiVersion: serving.kserve.io/v1beta1
kind: InferenceService
metadata:
name: sklearn-iris
annotations:
model-version: "4"
api-standard: "oip"
created-by: "worker-n"
spec:
predictor:
logger:
mode: all
url: http://message-dumper.default/
metadataAnnotations:
- "model-version"
- "api-standard"
- "created-by"
model:
modelFormat:
name: sklearn
storageUri: gs://kfserving-examples/models/sklearn/1.0/model
```
## Inference Logger with TLS

The InferenceService logger can be configured to use TLS for secure communication. The logger can be configured to use TLS by configuring the logger configuration in the `inferenceservice-config` ConfigMap.
Expand Down