Skip to content

Commit 6b38b1e

Browse files
committed
Rename 'visibility' dir to 'observability'
I'm making the name of this directory and section the same in all products. In partial fulfilment of https://tigera.atlassian.net/browse/DOCS-2516
1 parent 3f25a25 commit 6b38b1e

File tree

382 files changed

+955
-955
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

382 files changed

+955
-955
lines changed

calico-cloud/_includes/release-notes/_v3.15.0-release-notes.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ $[prodname] has improved its policy recommendation engine to add namespace-based
5151

5252
### New and improved Dashboards
5353

54-
$[prodname] includes new and improved Dashboards that enable operators to define cluster- and namespace-scoped dashboards with new modules for policy usage, application layer and DNS metrics, and much more. [Link to documentation](/visibility/get-started-cem)
54+
$[prodname] includes new and improved Dashboards that enable operators to define cluster- and namespace-scoped dashboards with new modules for policy usage, application layer and DNS metrics, and much more. [Link to documentation](/observability/get-started-cem)
5555

5656
### Included updates from Calico OSS
5757

calico-cloud/compliance/overview.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Compliance reports provide the following high-level information:
6767

6868
- Ensure that all nodes in your Kubernetes clusters are time-synchronized using NTP or similar (for accurate audit log timestamps)
6969

70-
- [Configure audit logs for Kubernetes resources](../visibility/elastic/audit-overview.mdx)
70+
- [Configure audit logs for Kubernetes resources](../observability/elastic/audit-overview.mdx)
7171

7272
You must configure audit logs for Kubernetes resources through the Kubernetes API to get a complete view of all resources.
7373

calico-cloud/network-policy/staged-network-policies.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -179,5 +179,5 @@ spec:
179179
- [Staged Kubernetes network policy](../reference/resources/stagedkubernetesnetworkpolicy.mdx)
180180
- For details on how to configure RBAC for staged policy resources, see [Configuring RBAC for tiered policy](policy-tiers/rbac-tiered-policies.mdx)
181181
- For details on staged policy metrics, see
182-
- [Flow logs](../visibility/elastic/flow/datatypes.mdx)
182+
- [Flow logs](../observability/elastic/flow/datatypes.mdx)
183183
- [Prometheus metrics](../operations/monitor/metrics/index.mdx#content-main)

calico-cloud/observability/index.mdx

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
description: Use Elasticsearch logs for visibility into all network traffic with Kubernetes context.
3+
hide_table_of_contents: true
4+
---
5+
6+
import { DocCardLink, DocCardLinkLayout } from '/src/___new___/components';
7+
8+
# Observability and troubleshooting
9+
10+
See what's going on in your cluster with network observability tools and detailed logging.
11+
12+
## Getting started
13+
14+
<DocCardLinkLayout>
15+
<DocCardLink docId='observability/alerts' />
16+
<DocCardLink docId='observability/kibana' />
17+
<DocCardLink docId='observability/packetcapture' />
18+
<DocCardLink docId='observability/visualize-traffic' />
19+
</DocCardLinkLayout>
20+
21+
## Getting started with logs
22+
23+
<DocCardLinkLayout>
24+
<DocCardLink docId='observability/elastic/overview' />
25+
<DocCardLink docId='observability/elastic/archive-storage' />
26+
<DocCardLink docId='observability/elastic/overview' />
27+
<DocCardLink docId='observability/elastic/bgp' />
28+
<DocCardLink docId='observability/elastic/audit-overview' />
29+
</DocCardLinkLayout>
30+
31+
## Flow logs
32+
33+
<DocCardLinkLayout>
34+
<DocCardLink docId='observability/elastic/flow/datatypes' />
35+
<DocCardLink docId='observability/elastic/flow/filtering' />
36+
<DocCardLink docId='observability/elastic/flow/aggregation' />
37+
<DocCardLink docId='observability/elastic/flow/hep' />
38+
<DocCardLink docId='observability/elastic/flow/processpath' />
39+
<DocCardLink docId='observability/elastic/flow/tcpstats' />
40+
41+
</DocCardLinkLayout>
42+
43+
## DNS logs
44+
45+
<DocCardLinkLayout>
46+
<DocCardLink docId='observability/elastic/dns/dns-logs' />
47+
<DocCardLink docId='observability/elastic/dns/filtering-dns' />
48+
</DocCardLinkLayout>
49+
50+
## L7 logs
51+
52+
<DocCardLinkLayout>
53+
<DocCardLink docId='observability/elastic/l7/configure' />
54+
<DocCardLink docId='observability/elastic/l7/datatypes' />
55+
</DocCardLinkLayout>

calico-cloud/reference/component-resources/node/felix/configuration.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The full list of parameters which can be set is as follows.
7171
| `LogSeverityScreen` | `FELIX_LOGSEVERITYSCREEN` | The log severity above which logs are sent to the stdout. [Default: `Info`] | `Debug`, `Info`, `Warning`, `Error`, `Fatal` |
7272
| `LogSeveritySys` | `FELIX_LOGSEVERITYSYS` | The log severity above which logs are sent to the syslog. Set to `none` for no logging to syslog. [Default: `Info`] | `Debug`, `Info`, `Warning`, `Error`, `Fatal` |
7373
| `LogDebugFilenameRegex` | `FELIX_LOGDEBUGFILENAMEREGEX` | Controls which source code files have their Debug log output included in the logs. Only logs from files with names that match the given regular expression are included. The filter only applies to Debug level logs. [Default: `""`] | regex |
74-
| `PolicySyncPathPrefix` | `FELIX_POLICYSYNCPATHPREFIX` | File system path where Felix notifies services of policy changes over Unix domain sockets. This is required only if you're configuring [L7 logs](../../../../visibility/elastic/l7/configure.mdx), or [egress gateways](../../../../networking/egress/index.mdx). Set to `""` to disable. [Default: `""`] | string |
74+
| `PolicySyncPathPrefix` | `FELIX_POLICYSYNCPATHPREFIX` | File system path where Felix notifies services of policy changes over Unix domain sockets. This is required only if you're configuring [L7 logs](../../../../observability/elastic/l7/configure.mdx), or [egress gateways](../../../../networking/egress/index.mdx). Set to `""` to disable. [Default: `""`] | string |
7575
| `PrometheusGoMetricsEnabled` | `FELIX_PROMETHEUSGOMETRICSENABLED` | Set to `false` to disable Go runtime metrics collection, which the Prometheus client does by default. This reduces the number of metrics reported, reducing Prometheus load. [Default: `true`] | boolean |
7676
| `PrometheusMetricsEnabled` | `FELIX_PROMETHEUSMETRICSENABLED` | Set to `true` to enable the Prometheus metrics server in Felix. [Default: `false`] | boolean |
7777
| `PrometheusMetricsHost` | `FELIX_PROMETHEUSMETRICSHOST` | TCP network address that the Prometheus metrics server should bind to. [Default: `""`] | string |
@@ -245,7 +245,7 @@ for 1022 endpoints on the host.
245245
| `FlowLogsAggregationThresholdBytes` | `FELIX_FLOWLOGSAGGREGATIONTHRESHOLDBYTES` | `8192` | Default threshold to determine how far behind the pipeline for flow logs can get before aggregation starts in. Detecting a difference of 8192 bytes means increase 1 level, while a difference of 16384 means increasing two levels. This parameter will be used only when `FlowLogsDynamicAggregationEnabled` is set to `true`. |
246246
| `FlowLogsCollectProcessInfo` | `FELIX_FLOWLOGSCOLLECTPROCESSINFO` | `true` | If enabled Felix will load the kprobe BPF programs to collect process info. |
247247
| `FlowLogsCollectTcpStats` | `FELIX_FLOWLOGSCOLLECTTCPSTATS` | `true` | If enabled Felix will collect TCP socket stats using BPF and requires a recent kernel that supports BPF |
248-
| `FlowLogsCollectProcessPath` | `FELIX_FLOWLOGSCOLLECTPROCESSPATH` | `true` | If enabled, along with FlowLogsCollectProcessInfo, each flow log will contain the full path of the process executable and the arguments with which the executable was invoked. If path or arguments cannot be determined, Felix will fallback to using task names and arguments will be empty. For full functionality, this feature should be enabled via operator see [Enabling process path](../../../../visibility/elastic/flow/processpath.mdx) |
248+
| `FlowLogsCollectProcessPath` | `FELIX_FLOWLOGSCOLLECTPROCESSPATH` | `true` | If enabled, along with FlowLogsCollectProcessInfo, each flow log will contain the full path of the process executable and the arguments with which the executable was invoked. If path or arguments cannot be determined, Felix will fallback to using task names and arguments will be empty. For full functionality, this feature should be enabled via operator see [Enabling process path](../../../../observability/elastic/flow/processpath.mdx) |
249249
| `FlowLogsFilePerFlowProcessLimit` | `FELIX_FLOWLOGSFILEPERFLOWPROCESSLIMIT` | `2` | Specify the maximum number of flow log entries with distinct process information beyond which process information will be aggregated. |
250250
| `FlowLogsFilePerFlowProcessArgsLimit` | `FELIX_FLOWLOGSFILEPERFLOWPROCESSARGSLIMIT` | `5` | Specify the maximum number of arguments beyond which the process arguments will be aggregated. |
251251
| `DNSCacheFile` | `FELIX_DNSCACHEFILE` | `/var/run/calico/felix-dns-cache.txt` | The name of the file that Felix uses to preserve learned DNS information when restarting. |

0 commit comments

Comments
 (0)