mirror of
https://github.com/makeplane/plane.git
synced 2026-06-14 03:30:00 +00:00
Manish Gupta
095b1aa360
* [WEB-7447] feat: migrate CE telemetry from OTLP traces to OTLP metrics Replace span-based tracing (tracer.py) with OTLP observable gauges, mirroring the approach already used in plane-ee. Key changes: - Add otlp_endpoints.py — shared gRPC/HTTP endpoint helpers - Add telemetry_metrics.py — push_instance_metrics task using MeterProvider + observable gauges (service name: plane-ce-api) - User count excludes bots (is_bot=False) - Page count excludes bot-owned private pages only - Domain derived from WEB_URL env var - Celery beat entry replaced with timedelta schedule + configurable METRICS_PUSH_INTERVAL_MINUTES (default 360 min) - Add explicit opentelemetry-exporter-otlp-proto-grpc dep - Delete tracer.py and telemetry.py (no longer needed) Co-authored-by: Plane AI <noreply@plane.so> * fix: address review comments on CE telemetry metrics - harden grpc_endpoint_from_url for scheme-less OTLP_ENDPOINT values (e.g. "telemetry.plane.so:4317") by prepending "//" before urlparse - fix WEB_URL domain extraction for scheme-less values with same approach - replace N+1 workspace count queries (6×N) with 6 batched annotate(Count) aggregation queries — reduces DB load significantly at WORKSPACE_METRICS_LIMIT - add deterministic ordering (order_by created_at) to workspace slice - harden METRICS_PUSH_INTERVAL_MINUTES env parsing with try/except guard and positive-value validation to avoid crash on malformed input Co-authored-by: Plane AI <noreply@plane.so> * fix: cap METRICS_PUSH_INTERVAL_MINUTES to prevent timedelta overflow Add upper-bound check (10_000_000 minutes) and catch OverflowError alongside ValueError so an arbitrarily large env value cannot crash worker startup via timedelta(minutes=...) OverflowError. Co-authored-by: Plane AI <noreply@plane.so> --------- Co-authored-by: Plane AI <noreply@plane.so>
93 lines
3.2 KiB
Python
93 lines
3.2 KiB
Python
# Copyright (c) 2023-present Plane Software, Inc. and contributors
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
# See the LICENSE file for details.
|
|
|
|
# Python imports
|
|
import json
|
|
import secrets
|
|
import os
|
|
import requests
|
|
|
|
# Django imports
|
|
from django.core.management.base import BaseCommand, CommandError
|
|
from django.utils import timezone
|
|
|
|
|
|
# Module imports
|
|
from plane.license.models import Instance, InstanceEdition
|
|
from plane.license.bgtasks.telemetry_metrics import push_instance_metrics
|
|
|
|
|
|
class Command(BaseCommand):
|
|
help = "Check if instance in registered else register"
|
|
|
|
def add_arguments(self, parser):
|
|
# Positional argument
|
|
parser.add_argument("machine_signature", type=str, help="Machine signature")
|
|
|
|
def check_for_current_version(self):
|
|
if os.environ.get("APP_VERSION", False):
|
|
return os.environ.get("APP_VERSION")
|
|
|
|
try:
|
|
with open("package.json", "r") as file:
|
|
data = json.load(file)
|
|
return data.get("version", "v0.1.0")
|
|
except Exception:
|
|
self.stdout.write("Error checking for current version")
|
|
return "v0.1.0"
|
|
|
|
def check_for_latest_version(self, fallback_version):
|
|
try:
|
|
response = requests.get(
|
|
"https://api.github.com/repos/makeplane/plane/releases/latest",
|
|
timeout=10,
|
|
)
|
|
response.raise_for_status()
|
|
data = response.json()
|
|
return data.get("tag_name", fallback_version)
|
|
except Exception:
|
|
self.stdout.write("Error checking for latest version")
|
|
return fallback_version
|
|
|
|
def handle(self, *args, **options):
|
|
# Check if the instance is registered
|
|
instance = Instance.objects.first()
|
|
|
|
current_version = self.check_for_current_version()
|
|
latest_version = self.check_for_latest_version(current_version)
|
|
|
|
# If instance is None then register this instance
|
|
if instance is None:
|
|
machine_signature = options.get("machine_signature", "machine-signature")
|
|
|
|
if not machine_signature:
|
|
raise CommandError("Machine signature is required")
|
|
|
|
instance = Instance.objects.create(
|
|
instance_name="Plane Community Edition",
|
|
instance_id=secrets.token_hex(12),
|
|
current_version=current_version,
|
|
latest_version=latest_version,
|
|
last_checked_at=timezone.now(),
|
|
is_test=os.environ.get("IS_TEST", "0") == "1",
|
|
edition=InstanceEdition.PLANE_COMMUNITY.value,
|
|
)
|
|
|
|
self.stdout.write(self.style.SUCCESS("Instance registered"))
|
|
else:
|
|
self.stdout.write(self.style.SUCCESS("Instance already registered"))
|
|
|
|
# Update the instance details
|
|
instance.last_checked_at = timezone.now()
|
|
instance.current_version = current_version
|
|
instance.latest_version = latest_version
|
|
instance.is_test = os.environ.get("IS_TEST", "0") == "1"
|
|
instance.edition = InstanceEdition.PLANE_COMMUNITY.value
|
|
instance.save()
|
|
|
|
# Push instance metrics on registration
|
|
push_instance_metrics.delay()
|
|
|
|
return
|