Skip to content
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

chore: improved title structure #598

Merged
merged 2 commits into from
Dec 20, 2023
Merged

chore: improved title structure #598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71be177
chore: improved title structure
aaguiarz Dec 18, 2023
3db70cd
Merge branch 'main' into fixes-configuration
adriantam Dec 20, 2023
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
10 changes: 5 additions & 5 deletions docs/content/getting-started/setup-openfga/configure-openfga.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ http:

To learn how to run in in Docker, check our [Docker documentation](./docker-setup.mdx#pre-shared-key-authentication).

#### OIDC
### OIDC

To configure with OIDC authentication, you will first need to obtain the OIDC issuer and audience from your provider.

Expand Down Expand Up @@ -198,7 +198,7 @@ http:

To learn how to run in in Docker, check our [Docker documentation](./docker-setup.mdx#oidc-authentication).

### Profiler (pprof)
## Profiler (pprof)
:::caution Warning
Continuous profiling can be used in production deployments, but we recommend disabling it unless it is needed to troubleshoot specific performance or memory problems.
:::
Expand Down Expand Up @@ -284,7 +284,7 @@ OpenFGA telemetry data is collected by default starting on version `v0.3.5`. The
Please refer to the [docker-compose.yaml](https://github.com/openfga/openfga/blob/main/docker-compose.yaml) file as an example of how to collect Metrics and Tracing in OpenFGA in a Docker environment using the [OpenTelemetry Collector](https://opentelemetry.io/docs/concepts/data-collection/). This should serve as a good example that you can adjust for your specific deployment scenario.
:::

### Metrics
## Metrics

OpenFGA metrics are collected with the [Prometheus data format](https://prometheus.io/docs/concepts/data_model/) and exposed on address `0.0.0.0:2112/metrics`.

Expand All @@ -298,7 +298,7 @@ openfga run --metrics-addr=0.0.0.0:2114

To see the request latency per endpoint of your OpenFGA deployment, you can provide the `--metrics-enable-rpc-histograms` flag (`OPENFGA_METRICS_ENABLE_RPC_HISTOGRAMS` environment variable).

### Tracing
## Tracing

OpenFGA traces can be collected with the [OTLP data format](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md).

Expand All @@ -312,7 +312,7 @@ Tracing by default uses a insecure connection. You can enable TLS by using `--tr
It is not recommended to sample all traces (e.g. `--trace-sample-ratio=1`). You will need to adjust your sampling ratio based on the amount of traffic your deployment receives. Higher traffic will require less sampling and lower traffic can tolerate higher sampling ratios.
:::

### Logging
## Logging

OpenFGA generates structured logs by default, and it can be configured with the following flags:

Expand Down
4 changes: 2 additions & 2 deletions docs/content/getting-started/setup-openfga/playground.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Using OpenFGA Playground
title: Using the OpenFGA Playground
description: Setting up an OpenFGA server
sidebar_position: 4
slug: /getting-started/setup-openfga/playground
---
### Playground
# Using the OpenFGA Playground

The Playground facilitates rapid development by allowing you to visualize and model your application's authorization models and manage relationship tuples with a locally running OpenFGA instance.

Expand Down
Loading