Skip to content

Commit a166d93

Browse files
committed
installation instructions
1 parent 4be4734 commit a166d93

File tree

3 files changed

+48
-2
lines changed

3 files changed

+48
-2
lines changed

docs/monitoring/logs-and-metrics.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ The `kubernetes` JSONB column includes the following context:
8282

8383
- `pod_ip`, `pod_owner`
8484

85-
8685
### Metrics Pipeline
8786

8887
Metrics collection follows a similar pattern but does not need transformations:
@@ -108,6 +107,19 @@ sinks:
108107
codec: json
109108
```
110109

110+
## Installation
111+
112+
To install Vector, edit the [example Vector values file](../../examples/vector.yaml) to your desired settings and run the following commands:
113+
114+
```sh
115+
helm repo add vector https://helm.vector.dev
116+
helm repo update
117+
118+
helm install vector vector/vector \
119+
-n vector -f .\values.yaml \
120+
--create-namespace --version 0.46.0
121+
```
122+
111123
## PostgREST Integration
112124

113125
Vector sends data directly to PostgREST HTTP endpoints, which provides:

docs/monitoring/traces.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,24 @@ The `rebuild_otlp_format` transform is critical for ensuring traces conform to t
134134
- **Resource Attributes**: Restructures resource metadata into OTLP format
135135
- **Span Structure**: Builds the complete `resourceSpans` → `scopeSpans` → `spans` hierarchy
136136

137+
## Installation
138+
139+
To install Vector, edit the [example Vector values file](../../examples/vector.yaml) to your desired settings and run the following commands:
140+
141+
```sh
142+
helm install vector vector/vector \
143+
-n vector -f .\values.yaml \
144+
--create-namespace --version 0.46.0
145+
```
146+
147+
To install Phoenix, edit the [example Phoenix values file](../../examples/phoenix.yaml) to your desired settings and run the following commands:
148+
149+
```sh
150+
helm install phoenix oci://registry-1.docker.io/arizephoenix/phoenix-helm \
151+
-f .\values.yaml --version 4.0.7 \
152+
-n phoenix --create-namespace
153+
```
154+
137155
## Observability Backends
138156

139157
### Phoenix

docs/user/DependencyInstall.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ helm install kueue oci://registry.k8s.io/kueue/charts/kueue \
7676

7777
SAS Retrieval Agent Manager requires the NGINX Ingress controller for managing incoming traffic.
7878

79-
Here is an [Example NGINX Controller Values File](../../examples/nginx.yaml).
79+
Here is an [Example NGINX Controller Values File](../../examples/nginx.yaml). You can edit it as you'd like to fit your deployment.
8080

8181
You can install it onto your cluster with the following commands:
8282

@@ -94,6 +94,14 @@ helm install nginx-ingress-nginx-controller \
9494
--create-namespace
9595
```
9696

97+
### Vector
98+
99+
SAS Retrieval Agent Manager requires Vector for collecting, viewing, and managing logs/metrics.
100+
101+
Here is an [Example Vector Values File](../../examples/vector.yaml). You can edit it as you'd like to fit your deployment.
102+
103+
You can install it onto your cluster by reading the [installation instructions found here](../monitoring/logs-and-metrics.md#installation).
104+
97105
## Optional Components
98106

99107
### Weaviate
@@ -116,3 +124,11 @@ helm install weaviate weaviate/weaviate \
116124
-f <weaviate_values_file> \
117125
--create-namespace
118126
```
127+
128+
### Phoenix
129+
130+
SAS Retrieval Agent Manager supports [Phoenix](https://github.com/Arize-ai/phoenix), an open-source observability platform for LLM applications.
131+
132+
Here is an [Example Phoenix Values File](../../examples/phoenix.yaml). You can edit it as you'd like to fit your deployment.
133+
134+
You can look at [installation instructions here](../monitoring/traces.md#installation).

0 commit comments

Comments
 (0)