mitol-django-olposthog 2024.5.14

mitol-django-olposthog

这是Open Learning OlPosthog应用程序。它提供了一个API与Posthog交互，以检查功能标志。

安装和设置

添加OlPosthog应用程序

docker-compose run -u root --rm web poetry add mitol-django-olposthog

将以下内容添加到您的App的ready()方法中。

from mitol.olposthog.features import configure
configure()

常见的Django设置

• HOSTNAME - 网站的域名。

OlPosthog应用程序设置

mitol-django-olposthog应用程序的所有设置都以前缀'POSTHOG'开头。

• POSTHOG_ENABLED - 为了在应用程序中启用Posthog功能标志，设置为True。设置为False以禁用Posthog功能标志。
• POSTHOG_PROJECT_API_KEY - 如果POSTHOG_ENABLED设置为True，则必需。用于与PostHog通信的私有API密钥。
• POSTHOG_API_HOST - 如果POSTHOG_ENABLED设置为True，则必需。PostHog API的主机URL。
• POSTHOG_FEATURE_FLAG_REQUEST_TIMEOUT_MS - PostHog功能标志请求的超时时间（毫秒）。
• POSTHOG_MAX_RETRIES - 在失败后重试请求到PostHog的次数。

缓存表创建

将以下缓存定义添加到您的Django应用程序settings.py文件中的CACHES中。

CACHES = {
  "durable": {
      "BACKEND": "django.core.cache.backends.db.DatabaseCache",
      "LOCATION": "durable_cache",
  },
}

您必须创建此库中包含的缓存。这可以通过在添加此库的Django应用程序内部运行以下命令来完成：./manage.py createcachetable。

用法

检查单个功能标志值

您可以使用以下代码检查Posthog上的功能标志值

from mitol.olposthog.features import is_enabled
is_enabled(<FEATURE_FLAG_NAME>)

这将根据Posthog功能标志是True还是False返回一个布尔值。

从Posthog检索所有功能标志

您可以使用以下方法从Posthog检索所有功能标志

from mitol.olposthog.features import get_all_feature_flags
get_all_feature_flags()