Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.
TypeScript acmeagentsai-agentscertificate-managementdevsecopsenvironment-variableskubernetesopen-sourcepampkipostgresprivate-caprivileged-access-managementsecret-managementsecret-managersecretssecrets-managementsecuritysecurity-toolsvault
import { PostHog } from "posthog-node";
import { TKeyStoreFactory } from "@app/keystore/keystore";
import { getConfig } from "@app/lib/config/env";
import { CronJobName, TCronJobFactory } from "@app/lib/cron/cron-job";
import { logger } from "@app/lib/logger";
import { TUsageCounterDALFactory } from "../license-client/usage";
import { getServerCfg } from "../super-admin/super-admin-service";
import { TTelemetryDALFactory } from "./telemetry-dal";
import {
TELEMETRY_SECRET_OPERATIONS_KEY,
TELEMETRY_SECRET_PROCESSED_KEY,
TTelemetryServiceFactory
} from "./telemetry-service";
import { PostHogEventTypes } from "./telemetry-types";
const AGGREGATED_EVENTS_HANDLER_TIMEOUT_MS = 8 * 60 * 1000;
const PKI_ORG_USAGE_HANDLER_TIMEOUT_MS = 15 * 60 * 1000;
type TTelemetryQueueServiceFactoryDep = {
cronJob: TCronJobFactory;
keyStore: Pick<TKeyStoreFactory, "getItem" | "deleteItem">;
telemetryDAL: TTelemetryDALFactory;
usageCounterDAL: Pick<TUsageCounterDALFactory, "getPkiUsageByRootOrg">;
telemetryService: Pick<TTelemetryServiceFactory, "processAggregatedEvents" | "setOrgGroupProperties">;
};
export type TTelemetryQueueServiceFactory = ReturnType<typeof telemetryQueueServiceFactory>;
export const telemetryQueueServiceFactory = ({
cronJob,
keyStore,
telemetryDAL,
usageCounterDAL,
telemetryService
}: TTelemetryQueueServiceFactoryDep) => {
const appCfg = getConfig();
const postHog =
appCfg.isProductionMode && appCfg.TELEMETRY_ENABLED
? new PostHog(appCfg.POSTHOG_PROJECT_API_KEY, { host: appCfg.POSTHOG_HOST, flushAt: 1, flushInterval: 0 })
: undefined;
// every day at midnight a telemetry job executes on self-hosted instances
const startTelemetryCheck = () => {
// cloud instances skip telemetry stats
if (appCfg.INFISICAL_CLOUD || !postHog) return;
cronJob.register({
name: CronJobName.TelemetryInstanceStats,
pattern: "0 0 * * *",
runHashTtlS: 3 * 24 * 60 * 60,
handler: async () => {
const { instanceId } = await getServerCfg();
const telemetryStats = await telemetryDAL.getTelemetryInstanceStats();
const numberOfSecretOperationsMade = parseInt(
(await keyStore.getItem(TELEMETRY_SECRET_OPERATIONS_KEY)) || "0",
10
);
const numberOfSecretProcessed = parseInt((await keyStore.getItem(TELEMETRY_SECRET_PROCESSED_KEY)) || "0", 10);
const stats = {
...telemetryStats,
numberOfSecretProcessed,
numberOfSecretOperationsMade,
...(appCfg.INFISICAL_PLATFORM_VERSION ? { infisicalVersion: appCfg.INFISICAL_PLATFORM_VERSION } : {})
};
postHog.capture({
event: PostHogEventTypes.TelemetryInstanceStats,
distinctId: instanceId,
properties: stats
});
await keyStore.deleteItem(TELEMETRY_SECRET_PROCESSED_KEY);
await keyStore.deleteItem(TELEMETRY_SECRET_OPERATIONS_KEY);
}
});
};
const startAggregatedEventsJob = () => {
if (!postHog) return;
cronJob.register({
name: CronJobName.TelemetryAggregatedEvents,
pattern: "*/10 * * * *",
runHashTtlS: 60 * 60,
handlerTimeoutMs: AGGREGATED_EVENTS_HANDLER_TIMEOUT_MS,
leaseDurationMs: AGGREGATED_EVENTS_HANDLER_TIMEOUT_MS,
handler: async () => {
await telemetryService.processAggregatedEvents();
}
});
};
const startPkiOrgUsageJob = () => {
if (!postHog) return;
cronJob.register({
name: CronJobName.TelemetryPkiOrgUsage,
pattern: "0 2 * * *",
runHashTtlS: 3 * 24 * 60 * 60,
handlerTimeoutMs: PKI_ORG_USAGE_HANDLER_TIMEOUT_MS,
leaseDurationMs: PKI_ORG_USAGE_HANDLER_TIMEOUT_MS,
handler: async () => {
const usage = await usageCounterDAL.getPkiUsageByRootOrg();
const countedAt = new Date().toISOString();
await telemetryService.setOrgGroupProperties(
usage.map(({ rootOrgId, cas, internalCas, activeCertificates, wildcardCertificates }) => ({
organizationId: rootOrgId,
properties: {
pki_active_certificates: activeCertificates,
pki_wildcard_certificates: wildcardCertificates,
pki_internal_cas: internalCas,
pki_cas: cas,
pki_usage_counted_at: countedAt
}
}))
);
logger.info(`telemetry: updated PKI org usage [orgCount=${usage.length}]`);
}
});
};
logger.info("telemetry queue service initialized");
return {
startTelemetryCheck,
startAggregatedEventsJob,
startPkiOrgUsageJob
};
};