Custom Resource Tags

Created:2024-06-01 Last Modified:2024-07-04

This document was translated by ChatGPT

#1. K8s Label

DeepFlow currently supports automatically associating K8s custom Labels with the following resources:

  • Container services
  • Workloads
    • Deployment
    • StatefulSet
    • DaemonSet
    • ReplicationController
    • CafeDeployment
    • CloneSet
  • ReplicaSet/InPlaceSet
  • Pod

#2. K8s Annotation

DeepFlow (Enterprise Edition only) currently supports automatically associating K8s custom Annotations with the following resources:

  • Container services
  • Pod

#3. K8s Env

DeepFlow (Enterprise Edition only) currently supports automatically associating K8s custom Annotations with the following resources:

  • Pod

#4. Cloud Resource Custom Tags

DeepFlow (Enterprise Edition only) currently supports automatically associating cloud resource custom tags with the following resources:

  • Cloud servers

Supported public cloud providers include:

  • Aliyun 阿里云
  • Tencent Cloud 腾讯云
  • Huawei Cloud 华为云

Supported private cloud providers include:

  • Aliyun Private Cloud

#5. Custom Auto Grouping Tags

The DeepFlow system by default provides two auto-grouping tags: auto_instance and auto_service:

  • auto_instance: Automatically identifies the corresponding instance tag based on IP or process ID. The system sets recognizable tags and their priorities (Container POD > Process > Container Node > Others > IP).
Value DisplayName Description
0 Internet IP
1 Cloud Host
5 Router
6 VM Hypervisor
9 DHCP Gateway
10 K8s POD
11 K8s Service
12 Redis
13 RDS
14 K8s Node
15 Load Balancer
16 NAT Gateway
120 Process
255 IP

generate from csv file: auto_instance_type.en

  • auto_service: Automatically identifies the corresponding service tag based on IP or process ID. The system sets recognizable tags and their priorities (Container Service > Workload > Process > Container Cluster > Others > IP).
    • Compared to auto_instance, auto_service removes Container POD and adds tags like Container Service and Workload that better reflect services. The priority of Container Service recognition is higher than Workload, so when an IP belongs to both Container Service and Workload, it will be recognized as Container Service.
Value DisplayName Description
0 Internet IP
1 Cloud Host
5 Router
6 VM Hypervisor
9 DHCP Gateway
11 K8s Service
12 Redis
13 RDS
14 K8s Node
15 Load Balancer
16 NAT Gateway
101 K8s Workload
102 Service
103 K8s Cluster
120 Process
130 Deployment
131 StatefulSet
132 ReplicationController
133 DaemonSet
134 ReplicaSetController
135 CloneSet
255 IP

generate from csv file: auto_service_type.en

DeepFlow also supports the ability to customize auto-grouping tags. You can configure the tags and their priorities as needed. The configuration document is as follows:

todo
1

The usage of the defined $tag-name tag is basically the same as auto_instance/auto_service, with the following restrictions:

  • * cannot be used for grouping simultaneously with $tag-name
  • Tags included in $tag_values cannot be used for grouping simultaneously with $tag-name