Skip to content

feat: Add Metrics to SharpHound to be collected - BED-7080 #2510

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

Open
mykeelium wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: Add Metrics to SharpHound to be collected - BED-7080 #2510

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
45c29a4
feat: add query parameters for labels and labelValues
mykeelium Feb 19, 2026
dab8483
chore: add client metrics parameter
mykeelium Mar 16, 2026
e382586
chore: pfc
mykeelium Mar 16, 2026
7582d4b
chore: pfc
mykeelium Mar 16, 2026
d7e8880
chore: remove query parameters for labels
mykeelium Mar 24, 2026
01cb851
fix: correct merge conflict
mykeelium Mar 24, 2026
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
24 changes: 23 additions & 1 deletion cmd/api/src/model/appcfg/parameter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ const (
ReconciliationKey ParameterKey = "analysis.reconciliation"
ScheduledAnalysis ParameterKey = "analysis.scheduled"
SupportAccountProvisioningKey ParameterKey = "auth.support_account_provisioning"
ClientMetricsKey ParameterKey = "pipeline.client_metrics"

// The below keys are not intended to be user updatable, so should not be added to IsValidKey
TrustedProxiesConfig ParameterKey = "http.trusted_proxies"
Expand Down Expand Up @@ -92,7 +93,7 @@ func (s *Parameter) Map(value any) error {

func (s *Parameter) IsValidKey(parameterKey ParameterKey) bool {
switch parameterKey {
case PasswordExpirationWindow, Neo4jConfigs, PruneTTL, CitrixRDPSupportKey, ReconciliationKey, ScheduledAnalysis, SupportAccountProvisioningKey:
case PasswordExpirationWindow, Neo4jConfigs, PruneTTL, CitrixRDPSupportKey, ReconciliationKey, ScheduledAnalysis, SupportAccountProvisioningKey, ClientMetricsKey:
return true
default:
return false
Expand Down Expand Up @@ -155,6 +156,8 @@ func (s *Parameter) Validate() utils.Errors {
v = &EnvironmentTargetedAccessControlParameters{}
case SupportAccountProvisioningKey:
v = &SupportAccountProvisioningParameters{}
case ClientMetricsKey:
v = &ClientMetricsParameter{}
default:
return utils.Errors{errors.New("invalid key")}
}
Expand Down Expand Up @@ -624,3 +627,22 @@ func GetSupportAccountProvisioningParameters(ctx context.Context, service Parame

return result
}

type ClientMetricsParameter struct {
Enabled bool `json:"enabled,omitempty"`
}

func GetClientMetricsParameter(ctx context.Context, service ParameterService) ClientMetricsParameter {
result := ClientMetricsParameter{
Enabled: false,
}

if clientMetricsCfg, err := service.GetConfigurationParameter(ctx, ClientMetricsKey); err != nil {
slog.WarnContext(ctx, "Failed to fetch client metrics configuration; returning default values")
} else if err = clientMetricsCfg.Map(&result); err != nil {
slog.WarnContext(ctx, "Invalid client metrics configuration supplied; returning default values",
attr.Error(err))
}

return result
}
Loading