Flux installation method
The report is available no matter the tool used to install Flux,
be it the `flux` CLI, Terraform, Helm or the Flux Operator itself.
For the report to be accurate, the operator must be running
in the same namespace where the Flux controllers are deployed.
To view the report in YAML format run:
```shell
kubectl -n flux-system get fluxreport/flux -o yaml
```
The operator updates the report at regular intervals, by default every five minutes.
To manually trigger the reconciliation of the report, run:
```shell
kubectl -n flux-system annotate --overwrite fluxreport/flux \
reconcile.fluxcd.io/requestedAt="$(date +%s)"
```
Find more information about the reporting features
in the [Flux Report API documentation](/docs/crd/fluxreport/).
## Flux Instance Events
The Flux Operator emits events to the Kubernetes API server to report on the status of the Flux
instance. The events are useful to monitor the Flux lifecycle and troubleshoot upgrade issues.
To list the events related to the Flux instance, run:
```shell
kubectl -n flux-system events --for fluxinstance/flux
```
The Flux Operator integrates with notification-controller. To receive notifications with the
events issued by the operator, you can configure alerting as follows:
```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta3
kind: Provider
metadata:
name: slack-bot
namespace: flux-system
spec:
type: slack
channel: general
address: https://slack.com/api/chat.postMessage
secretRef:
name: slack-bot-token
---
apiVersion: notification.toolkit.fluxcd.io/v1beta3
kind: Alert
metadata:
name: flux-operator
namespace: flux-system
spec:
providerRef:
name: slack-bot
eventSeverity: info
eventSources:
- kind: FluxInstance
name: flux
```
Besides Slack, the notification-controller supports other providers like Microsoft Teams, Datadog, Grafana, etc.,
for more information see the [alert provider documentation](/docs/crd/provider/).
## Prometheus Metrics
The Flux Operator exports metrics in the Prometheus format for monitoring
and alerting purposes. The metrics are exposed inside the cluster by the
`flux-operator` Kubernetes Service on the `8080` port.
On clusters where the Prometheus Operator is installed, the metrics can be scraped
by creating a `ServiceMonitor` resource as follows:
```yaml
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: flux-operator
namespace: flux-system
labels:
release: kube-prometheus-stack
spec:
namespaceSelector:
matchNames:
- flux-system
selector:
matchLabels:
app.kubernetes.io/name: flux-operator
endpoints:
- targetPort: 8080
path: /metrics
interval: 30s
```
It is recommended to change the reporting interval to `30s` when using the Prometheus metrics
exported by the operator:
```shell
helm upgrade flux-operator oci://ghcr.io/controlplaneio-fluxcd/charts/flux-operator \
--namespace flux-system \
--set reporting.interval=30s
```