Skip to content
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.

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

[CONTP-390] Allow user to set the cardinality of a check in the check configuration #29984

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

Conversation

zhuminyi
Copy link
Contributor

@zhuminyi zhuminyi commented Oct 9, 2024

What does this PR do?

Add check_tag_cardinality option in the check configuration. And if the user sets it, it overrides the value provided in the agent configuration.
See difference below

The cardinality is passed into this function in configresolver

	if tpl.CheckTagCardinality != "" {
		tags, err = svc.GetTagsWithCardinality(tpl.CheckTagCardinality)
	} 

Motivation

This will allow user to configure the cardinality of check instance (configured with a Pod annotation) directly inside the annotation check config.

Describe how to test/QA your changes

deploy dummy app

---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: redis
  namespace: workload-redis-test
  labels:
    app: redis
spec:
  replicas: 1
  selector:
    matchLabels:
      app: redis
  template:
    metadata:
      labels:
        app: redis
        service: redis
        team: container-integrations
        chart_name: redis_chart
      annotations:
        ad.datadoghq.com/redis.checks: |
          {
            "redisdb": {
              "init_config": {},
              "check_tag_cardinality": "low",
              "instances": [
                {
                  "host": "%%host%%",
                  "port": "6379"
                }
              ]
            }
          }
        ad.datadoghq.com/redis.logs: '[{"type": "docker","image": "redis","service": "redis","source": "redis"}]'
        ad.datadoghq.com/tags: '{redis_port: "REDIS_VERSION_%%env_REDIS_VERSION%%"}'
    spec:
      containers:
        - name: redis
          image: redis:latest
          resources:
            limits:
              cpu: 2000m
              memory: 64Mi
            requests:
              cpu: 1000m
              memory: 64Mi
---
apiVersion: v1
kind: Service
metadata:
  name: redis
  namespace: workload-redis-test
  labels:
    app: redis
spec:
  selector:
    app: redis
  ports:
    - name: redis
      port: 6379
      targetPort: 6379

Compare config
"check_tag_cardinality": "low" vs
"check_tag_cardinality": "high",
Screenshot 2024-10-10 at 4 23 13 PM

Container name is high cardinality tag.

Also run agent configcheck | grep redis -C 15

high

=== redisdb check ===
Configuration provider: kubernetes-container-allinone
Configuration source: container:containerd://5157e690ea25a4386c855b1208d10b0bca42b2e6561bd90ad30fdeadfebb6fe4
Config for instance ID: redisdb:52cac392cc9736a1
host: 10.244.0.69
port: "6379"
tags:
- container_id:5157e690ea25a4386c855b1208d10b0bca42b2e6561bd90ad30fdeadfebb6fe4
- container_name:redis
- display_container_name:redis_redis-7fbdd8797c-dszpj
- image_id:********@sha256:11a62e03dc70b18fe3e18532f751dcb941a6432920bf4cfbf37e36a13ed48711
- image_name:us-east4-docker.pkg.dev/datadog-sandbox/mztest/redis
- image_tag:latest
- kube_container_name:redis
- kube_deployment:redis
- kube_namespace:workload-redis-test
- kube_ownerref_kind:replicaset
- kube_ownerref_name:redis-7fbdd8797c
- kube_qos:Burstable
- kube_replica_set:redis-7fbdd8797c
- kube_service:redis
- pod_name:redis-7fbdd8797c-dszpj
- pod_phase:running
- short_image:redis

low

Config for instance ID: redisdb:f54e4b63528529bf
host: 10.244.0.70
port: "6379"
tags:
- image_id:********@sha256:11a62e03dc70b18fe3e18532f751dcb941a6432920bf4cfbf37e36a13ed48711
- image_name:us-east4-docker.pkg.dev/datadog-sandbox/mztest/redis
- image_tag:latest
- kube_container_name:redis
- kube_deployment:redis
- kube_namespace:workload-redis-test
- kube_ownerref_kind:replicaset
- kube_qos:Burstable
- kube_replica_set:redis-5b49bb7567
- kube_service:redis
- pod_phase:running
- short_image:redis

Possible Drawbacks / Trade-offs

Additional Notes

@zhuminyi zhuminyi requested review from a team as code owners October 9, 2024 14:51
@github-actions github-actions bot added the team/container-platform The Container Platform Team label Oct 9, 2024
@zhuminyi zhuminyi added this to the 7.60.0 milestone Oct 9, 2024
@zhuminyi zhuminyi marked this pull request as draft October 9, 2024 17:53
@zhuminyi zhuminyi force-pushed the cardinality_override branch 4 times, most recently from f7a7116 to dc3045b Compare October 9, 2024 20:50
Copy link

cit-pr-commenter bot commented Oct 9, 2024

Regression Detector

Regression Detector Results

Run ID: fade32d6-84c8-4eb0-be1a-bfb0cf50ddfb Metrics dashboard Target profiles

Baseline: e0456b1
Comparison: c68540d

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

No significant changes in experiment optimization goals

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +0.82 [+0.10, +1.54] 1 Logs
idle memory utilization +0.29 [+0.24, +0.33] 1 Logs bounds checks dashboard
idle_all_features memory utilization +0.08 [-0.03, +0.18] 1 Logs bounds checks dashboard
otel_to_otel_logs ingress throughput +0.03 [-0.78, +0.84] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.01 [-0.24, +0.26] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.00 [-0.22, +0.22] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.01 [-0.35, +0.32] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.11, +0.09] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.05 [-0.53, +0.43] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.07 [-0.26, +0.11] 1 Logs
file_tree memory utilization -0.16 [-0.28, -0.04] 1 Logs
quality_gate_idle memory utilization -0.19 [-0.24, -0.14] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization -0.57 [-0.67, -0.47] 1 Logs bounds checks dashboard
pycheck_lots_of_tags % cpu utilization -0.65 [-3.09, +1.80] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.94 [-0.99, -0.88] 1 Logs
basic_py_check % cpu utilization -1.76 [-4.40, +0.89] 1 Logs

Bounds Checks

perf experiment bounds_check_name replicates_passed
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
idle memory_usage 10/10
idle_all_features memory_usage 10/10
quality_gate_idle memory_usage 10/10
quality_gate_idle_all_features memory_usage 10/10

Explanation

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

@zhuminyi zhuminyi force-pushed the cardinality_override branch 2 times, most recently from 1bbc6a6 to 1f5eb30 Compare October 10, 2024 03:23
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Oct 10, 2024

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv create-vm --pipeline-id=47046987 --os-family=ubuntu

Note: This applies to commit c68540d

@zhuminyi zhuminyi marked this pull request as ready for review October 10, 2024 20:29
@zhuminyi zhuminyi requested a review from a team as a code owner October 11, 2024 15:00
Copy link
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@rayz rayz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm for AML

Copy link
Member

@NouemanKHAL NouemanKHAL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for comp/core/autodiscovery/listeners/cloudfoundry.go

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team/container-platform The Container Platform Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants