:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import { useActions, useValues } from 'kea'
import { Form } from 'kea-forms'
import { IconEllipsis, IconPlusSmall } from '@posthog/icons'
import {
LemonButton,
LemonDialog,
LemonInput,
LemonLabel,
LemonMenu,
LemonModal,
LemonSelect,
LemonTable,
LemonTableColumns,
} from '@posthog/lemon-ui'
import { PropertyFilters } from 'lib/components/PropertyFilters/PropertyFilters'
import { RestrictionScope, useRestrictedArea } from 'lib/components/RestrictedArea'
import { TaxonomicFilterGroupType } from 'lib/components/TaxonomicFilter/types'
import { TaxonomicStringPopover } from 'lib/components/TaxonomicPopover/TaxonomicPopover'
import { TestAccountFilterSwitch } from 'lib/components/TestAccountFiltersSwitch'
import { TeamMembershipLevel } from 'lib/constants'
import { useOnMountEffect } from 'lib/hooks/useOnMountEffect'
import { groupsAccessLogic } from 'lib/introductions/groupsAccessLogic'
import { LemonField } from 'lib/lemon-ui/LemonField'
import { eventUsageLogic } from 'lib/utils/eventUsageLogic'
import { cdpFiltersToSeries, seriesToCdpFilters } from 'scenes/hog-functions/filters/cdpFilterSeries'
import { SeriesActionFilter } from 'scenes/insights/filters/ActionFilter/ActionFilter'
import { MathAvailability } from 'scenes/insights/filters/ActionFilter/ActionFilterRow/types'
import { NodeKind } from '~/queries/schema/schema-general'
import { AnyPropertyFilter, ChartDisplayCategory } from '~/types'
import type { GroupUsageMetricApi } from 'products/customer_analytics/frontend/generated/api.schemas'
import {
UsageMetricEventFilters,
UsageMetricFiltersDataWarehouse,
UsageMetricFormData,
actionFilterValueToSavedFilters,
getMetricSource,
savedFiltersToActionFilterValue,
usageMetricsConfigLogic,
} from './usageMetricsConfigLogic'
function UsageMetricsTable(): JSX.Element {
const { usageMetrics, usageMetricsLoading } = useValues(usageMetricsConfigLogic)
const { removeUsageMetric, openModal, setUsageMetricValues } = useActions(usageMetricsConfigLogic)
const { reportUsageMetricsUpdateButtonClicked } = useActions(eventUsageLogic)
const restrictedReason = useRestrictedArea({
scope: RestrictionScope.Project,
minimumAccessLevel: TeamMembershipLevel.Admin,
})
const columns: LemonTableColumns<GroupUsageMetricApi> = [
{
title: 'Name',
key: 'name',
dataIndex: 'name',
},
{
title: 'Format',
key: 'format',
dataIndex: 'format',
},
{
title: 'Interval',
key: 'interval',
dataIndex: 'interval',
},
{
title: 'Display',
key: 'display',
render: function Render(_, metric) {
return metric.display === 'sparkline' ? 'Sparkline' : 'Number'
},
},
{
title: 'Source',
key: 'source',
render: function Render(_, metric) {
const source = getMetricSource(metric.filters as UsageMetricFormData['filters'])
if (source === 'data_warehouse') {
const dwFilters = metric.filters as UsageMetricFiltersDataWarehouse
return `Warehouse · ${dwFilters?.table_name ?? '(unknown table)'}`
}
return 'Events'
},
},
{
title: 'Calculation',
key: 'math',
render: function Render(_, metric) {
if (metric.math === 'sum') {
return `Sum of ${metric.math_property ?? '(unknown)'}`
}
return 'Count'
},
},
{
title: '',
key: 'actions',
width: 24,
render: function Render(_, metric) {
return (
<LemonMenu
items={[
{
label: 'Edit',
onClick: () => {
openModal()
setUsageMetricValues({
...metric,
filters: (metric.filters ?? {}) as UsageMetricEventFilters,
})
reportUsageMetricsUpdateButtonClicked()
},
disabledReason: restrictedReason,
},
{
label: 'Delete',
status: 'danger',
onClick: () => {
LemonDialog.open({
title: 'Delete usage metric',
description: `Are you sure you want to delete "${metric.name}"? This action cannot be undone.`,
primaryButton: {
children: 'Delete',
status: 'danger',
onClick: () => {
removeUsageMetric(metric.id)
},
disabledReason: restrictedReason,
},
secondaryButton: {
children: 'Cancel',
},
})
},
disabledReason: restrictedReason,
},
]}
>
<LemonButton size="small" icon={<IconEllipsis />} />
</LemonMenu>
)
},
},
]
return <LemonTable columns={columns} dataSource={usageMetrics} loading={usageMetricsLoading} />
}
function UsageMetricsForm(): JSX.Element {
const { usageMetric } = useValues(usageMetricsConfigLogic)
const { setUsageMetricValue } = useActions(usageMetricsConfigLogic)
const taxonomicGroupTypes = [
TaxonomicFilterGroupType.EventProperties,
TaxonomicFilterGroupType.PersonProperties,
TaxonomicFilterGroupType.EventMetadata,
TaxonomicFilterGroupType.HogQLExpression,
]
const source = getMetricSource(usageMetric.filters)
return (
<Form id="usageMetric" logic={usageMetricsConfigLogic} formKey="usageMetric" enableFormOnSubmit>
<div className="flex flex-col gap-2">
<div className="grid grid-cols-2 gap-2">
<LemonField name="name" label="Name">
<LemonInput placeholder="Events" />
</LemonField>
<LemonField name="interval" label="Interval">
<LemonSelect
options={[
{ value: 7, label: '7d' },
{ value: 30, label: '30d' },
{ value: 90, label: '90d' },
]}
/>
</LemonField>
<LemonField name="format" label="Format">
<LemonSelect
options={[
{ value: 'currency', label: 'Currency' },
{ value: 'numeric', label: 'Numeric' },
]}
/>
</LemonField>
<LemonField name="display" label="Display">
<LemonSelect
options={[
{ value: 'number', label: 'Number' },
{ value: 'sparkline', label: 'Sparkline' },
]}
/>
</LemonField>
<LemonField name="math" label="Calculation">
{({ value, onChange }) => (
<LemonSelect
value={value}
options={[
{
value: 'count',
label: source === 'data_warehouse' ? 'Count of rows' : 'Count of events',
},
{
value: 'sum',
label: source === 'data_warehouse' ? 'Sum of column' : 'Sum of property',
},
]}
onChange={(newValue) => {
onChange(newValue)
if (newValue === 'count') {
setUsageMetricValue('math_property', null)
}
}}
/>
)}
</LemonField>
{usageMetric.math === 'sum' && (
<LemonField
name="math_property"
label={source === 'data_warehouse' ? 'Column to sum' : 'Property to sum'}
>
{({ value, onChange }) =>
source === 'data_warehouse' ? (
<LemonInput
value={value ?? ''}
onChange={(newValue) => onChange(newValue || null)}
placeholder="amount"
data-attr="usage-metric-math-property"
/>
) : (
<TaxonomicStringPopover
groupType={TaxonomicFilterGroupType.NumericalEventProperties}
value={value}
onChange={onChange}
placeholder="Select property"
data-attr="usage-metric-math-property"
selectingKeyOnly
/>
)
}
</LemonField>
)}
</div>
<div className="grid grid-cols-1 gap-2">
<LemonField
name="filters"
label="Match events or data warehouse table"
help={
source === 'data_warehouse'
? 'Data warehouse metrics are limited to a single table and currently only render on group profiles.'
: 'Pick events to match, or switch to a data warehouse table. Only one source can be active per metric.'
}
>
{({ value, onChange }) => {
const actionFilterValue = savedFiltersToActionFilterValue(value)
return (
<>
<SeriesActionFilter
bordered
series={cdpFiltersToSeries(actionFilterValue)}
onChange={(series) => {
onChange(
actionFilterValueToSavedFilters(seriesToCdpFilters(series), source)
)
}}
trendsDisplayCategory={ChartDisplayCategory.TimeSeries}
typeKey="usage-metric-filters"
mathAvailability={MathAvailability.None}
hideRename
hideDuplicate
showNestedArrow={false}
entitiesLimit={source === 'data_warehouse' ? 1 : undefined}
actionsTaxonomicGroupTypes={[
TaxonomicFilterGroupType.Events,
TaxonomicFilterGroupType.DataWarehouse,
]}
propertiesTaxonomicGroupTypes={taxonomicGroupTypes}
propertyFiltersPopover
dataWarehousePopoverFields={[
{ key: 'timestamp_field', label: 'Timestamp column', allowHogQL: true },
{ key: 'key_field', label: 'Group key column' },
]}
newSeriesDefaults={{
kind: NodeKind.EventsNode,
event: '$pageview',
name: '$pageview',
}}
buttonCopy={
(actionFilterValue?.events ?? []).length > 0
? 'Add event'
: 'Match event or data warehouse table'
}
/>
{source === 'events' && (
<>
<div className="flex gap-2 justify-between w-full">
<LemonLabel>Filters</LemonLabel>
</div>
<PropertyFilters
propertyFilters={
(actionFilterValue?.properties ?? []) as AnyPropertyFilter[]
}
taxonomicGroupTypes={taxonomicGroupTypes}
onChange={(properties: AnyPropertyFilter[]) => {
onChange(
actionFilterValueToSavedFilters(
{ ...actionFilterValue, properties },
source
)
)
}}
pageKey="UsageMetricsConfig"
/>
<TestAccountFilterSwitch
checked={actionFilterValue?.filter_test_accounts ?? false}
onChange={(filter_test_accounts) => {
onChange(
actionFilterValueToSavedFilters(
{ ...actionFilterValue, filter_test_accounts },
source
)
)
}}
fullWidth
/>
</>
)}
</>
)
}}
</LemonField>
</div>
</div>
</Form>
)
}
export function UsageMetricsConfig(): JSX.Element {
const { openModal } = useActions(usageMetricsConfigLogic)
const { groupsEnabled } = useValues(groupsAccessLogic)
const { reportUsageMetricsSettingsViewed } = useActions(eventUsageLogic)
const restrictedReason = useRestrictedArea({
scope: RestrictionScope.Project,
minimumAccessLevel: TeamMembershipLevel.Admin,
})
useOnMountEffect(() => {
reportUsageMetricsSettingsViewed()
})
return (
<>
<p>
Define what usage means for your product based on one or more events.
<br />
Usage metrics are displayed in the person {groupsEnabled ? 'and group profiles' : 'profile'}.
</p>
<div className="flex flex-col gap-2 items-start">
<LemonButton
type="primary"
size="small"
onClick={openModal}
icon={<IconPlusSmall />}
disabledReason={restrictedReason}
>
Add metric
</LemonButton>
<UsageMetricsTable />
<UsageMetricsModal />
</div>
</>
)
}
export function UsageMetricsModal(): JSX.Element {
const { isModalOpen } = useValues(usageMetricsConfigLogic)
const { closeModal } = useActions(usageMetricsConfigLogic)
return (
<LemonModal
title="Add usage metric"
isOpen={isModalOpen}
onClose={closeModal}
children={<UsageMetricsForm />}
footer={
<>
<LemonButton
htmlType="submit"
form="usageMetric"
type="primary"
children="Save"
data-attr="create-usage-metric"
/>
<LemonButton children="Cancel" onClick={closeModal} data-attr="cancel-create-usage-metric" />
</>
}
/>
)
}