Use "type" instead of "service_type" and kept "instance"

Author: PierreF

agent/metric_test.go

@@ -53,8 +53,8 @@ var (
 		},
 		Services: []config.Service{
 			{
-				ServiceType: "myapplication",
-				JMXPort:     1234,
+				Type:    "myapplication",
+				JMXPort: 1234,
 				JMXMetrics: []config.JmxMetric{
 					{
 						Name:      "heap_size_mb",
@@ -72,11 +72,11 @@ var (
 				},
 			},
 			{
-				ServiceType: "apache",
-				Address:     "127.0.0.1",
-				Port:        80,
-				HTTPPath:    "/",
-				HTTPHost:    "127.0.0.1:80",
+				Type:     "apache",
+				Address:  "127.0.0.1",
+				Port:     80,
+				HTTPPath: "/",
+				HTTPHost: "127.0.0.1:80",
 			},
 		},
 	}

config/config.go

@@ -544,8 +544,7 @@ func migrateScrapper(k *koanf.Koanf, config map[string]interface{}, deprecatedPa
 func migrateServices(config map[string]interface{}) prometheus.MultiError {
 	migratedOptions := map[string]string{
 		"cassandra_detailed_tables": "detailed_items",
-		"id":                        "service_type",
-		"instance":                  "service_instance",
+		"id":                        "type",
 		"mgmt_port":                 "stats_port",
 	}
 

config/config_test.go

@@ -265,8 +265,8 @@ func TestStructuredConfig(t *testing.T) { //nolint:maintidx
 		},
 		Services: []Service{
 			{
-				ServiceType:       "service1",
-				ServiceInstance:   "instance1",
+				Type:              "service1",
+				Instance:          "instance1",
 				Port:              8080,
 				IgnorePorts:       []int{8081},
 				Address:           "127.0.0.1",
@@ -717,7 +717,7 @@ func TestLoad(t *testing.T) { //nolint:maintidx
 			WantConfig: Config{
 				Services: []Service{
 					{
-						ServiceType:  "service1",
+						Type:         "service1",
 						CheckType:    "nagios",
 						CheckCommand: "/path/to/bin --with-option",
 					},
@@ -838,7 +838,7 @@ func TestLoad(t *testing.T) { //nolint:maintidx
 			WantConfig: Config{
 				Services: []Service{
 					{
-						ServiceType: "cassandra",
+						Type: "cassandra",
 						DetailedItems: []string{
 							"keyspace.table1",
 							"keyspace.table2",
@@ -856,8 +856,8 @@ func TestLoad(t *testing.T) { //nolint:maintidx
 			WantConfig: Config{
 				Services: []Service{
 					{
-						ServiceType: "service1",
-						StatsPort:   9090,
+						Type:      "service1",
+						StatsPort: 9090,
 					},
 				},
 			},
@@ -878,49 +878,30 @@ func TestLoad(t *testing.T) { //nolint:maintidx
 			Files: []string{"testdata/deprecated_service_id.conf"},
 			WantWarnings: []string{
 				"testdata/deprecated_service_id.conf: setting is deprecated in 'service' override: 'id'" +
-					", use 'service_type' instead",
+					", use 'type' instead",
 			},
 			WantConfig: Config{
 				Services: []Service{
 					{
-						ServiceType: "apache",
-						Port:        1234,
+						Type: "apache",
+						Port: 1234,
 					},
 				},
 			},
 		},
 		{
-			Name:  "deprecated_service_instance",
-			Files: []string{"testdata/deprecated_service_instance.conf"},
+			Name:  "deprecated_service_id_with_instance",
+			Files: []string{"testdata/deprecated_service_id_with_instance.conf"},
 			WantWarnings: []string{
-				"testdata/deprecated_service_instance.conf: setting is deprecated in 'service' override: 'instance'" +
-					", use 'service_instance' instead",
+				"testdata/deprecated_service_id_with_instance.conf: setting is deprecated in 'service' override: 'id'" +
+					", use 'type' instead",
 			},
 			WantConfig: Config{
 				Services: []Service{
 					{
-						ServiceType:     "apache",
-						ServiceInstance: "my_container",
-						Port:            1234,
-					},
-				},
-			},
-		},
-		{
-			Name:  "deprecated_service_id_and_instance",
-			Files: []string{"testdata/deprecated_service_id_and_instance.conf"},
-			WantWarnings: []string{
-				"testdata/deprecated_service_id_and_instance.conf: setting is deprecated in 'service' override: 'id'" +
-					", use 'service_type' instead",
-				"testdata/deprecated_service_id_and_instance.conf: setting is deprecated in 'service' override: 'instance'" +
-					", use 'service_instance' instead",
-			},
-			WantConfig: Config{
-				Services: []Service{
-					{
-						ServiceType:     "apache",
-						ServiceInstance: "my_container",
-						Port:            1234,
+						Type:     "apache",
+						Instance: "my_container",
+						Port:     1234,
 					},
 				},
 			},
@@ -1177,13 +1158,13 @@ func TestDump(t *testing.T) {
 		},
 		Services: []Service{
 			{
-				ServiceType: "in-dump",
+				Type:        "in-dump",
 				Password:    "not-in-dump",
 				JMXPassword: "not-in-dump",
 				KeyFile:     "not-in-dump",
 			},
 			{
-				ServiceType: "in-dump-2",
+				Type:        "in-dump-2",
 				Password:    "",
 				JMXPassword: "",
 				KeyFile:     "",
@@ -1201,13 +1182,13 @@ func TestDump(t *testing.T) {
 		},
 		Services: []Service{
 			{
-				ServiceType: "in-dump",
+				Type:        "in-dump",
 				Password:    "*****",
 				JMXPassword: "*****",
 				KeyFile:     "*****",
 			},
 			{
-				ServiceType: "in-dump-2",
+				Type: "in-dump-2",
 				// In dump because these fields were unset.
 				Password:    "",
 				JMXPassword: "",

config/loader_test.go

@@ -184,8 +184,8 @@ func TestLoader(t *testing.T) {
 					"stats_protocol":      "",
 					"check_type":          "",
 					"ignore_ports":        nil,
-					"service_type":        "service1",
-					"service_instance":    "instance1",
+					"type":                "service1",
+					"instance":            "instance1",
 					"port":                0.0,
 					"stats_port":          0.0,
 					"check_command":       "",

config/testdata/deprecated_cassandra.conf

@@ -1,5 +1,5 @@
 service:
-  - service_type: "cassandra"
+  - type: "cassandra"
     cassandra_detailed_tables:
       - "keyspace.table1"
       - "keyspace.table2"

config/testdata/deprecated_mgmt_port.conf

@@ -1,3 +1,3 @@
 service:
-  - service_type: "service1"
+  - type: "service1"
     mgmt_port: 9090

config/testdata/deprecated_service_id_and_instance.conf renamed to config/testdata/deprecated_service_id_with_instance.conf

@@ -201,8 +201,8 @@ nvidia_smi:
   timeout: 5
 
 service:
-  - service_type: "service1"
-    service_instance: "instance1"
+  - type: "service1"
+    instance: "instance1"
     port: 8080
     ignore_ports:
       - 8081

config/testdata/deprecated_service_instance.conf

@@ -43,8 +43,8 @@ metric:
         target: 127.0.0.1
 
 service:
-  - service_type: "service1"
-    service_instance: "instance1"
+  - type: "service1"
+    instance: "instance1"
 
 service_ignore_metrics:
   - name: "redis"

config/testdata/full.conf

@@ -2,7 +2,7 @@ bleemeo:
   unused_key: "unused"
 
 service:
-  - service_type: "service1"
+  - type: "service1"
     check_type: "nagios"
     check_command: "/path/to/bin --with-option"
     another_key: 5

config/testdata/loader.conf

@@ -322,9 +322,9 @@ type Listener struct {
 
 type Service struct {
 	// The name of the service type, like "apache", "nginx". For custom service, it could be any value.
-	ServiceType string `yaml:"service_type"`
+	Type string `yaml:"type"`
 	// Instance of the service, used to differentiate between two same services (like two apaches)
-	ServiceInstance string `yaml:"service_instance"`
+	Instance string `yaml:"instance"`
 	// The port the service is running on.
 	Port int `yaml:"port"`
 	// Ports that should be ignored.

config/testdata/unused.conf

@@ -153,39 +153,39 @@ func validateServices(services []config.Service) (map[NameInstance]config.Servic
 	replacer := strings.NewReplacer(".", "_", "-", "_")
 
 	for _, srv := range services {
-		if srv.ServiceType == "" {
-			warning := fmt.Errorf("%w: the key \"service_type\" is missing in one of your service override", config.ErrInvalidValue)
+		if srv.Type == "" {
+			warning := fmt.Errorf("%w: the key \"type\" is missing in one of your service override", config.ErrInvalidValue)
 			warnings.Append(warning)
 
 			continue
 		}
 
-		if !model.IsValidMetricName(model.LabelValue(srv.ServiceType)) {
-			newServiceType := replacer.Replace(srv.ServiceType)
+		if !model.IsValidMetricName(model.LabelValue(srv.Type)) {
+			newServiceType := replacer.Replace(srv.Type)
 			if !model.IsValidMetricName(model.LabelValue(newServiceType)) {
 				warning := fmt.Errorf(
-					"%w: service_type \"%s\" can only contains letters, digits and underscore",
-					config.ErrInvalidValue, srv.ServiceType,
+					"%w: service type \"%s\" can only contains letters, digits and underscore",
+					config.ErrInvalidValue, srv.Type,
 				)
 				warnings.Append(warning)
 
 				continue
 			}
 
 			warning := fmt.Errorf(
-				"%w: service_type \"%s\" can not contains dot (.) or dash (-). Changed to \"%s\"",
-				config.ErrInvalidValue, srv.ServiceType, newServiceType,
+				"%w: service type \"%s\" can not contains dot (.) or dash (-). Changed to \"%s\"",
+				config.ErrInvalidValue, srv.Type, newServiceType,
 			)
 			warnings.Append(warning)
 
-			srv.ServiceType = newServiceType
+			srv.Type = newServiceType
 		}
 
 		// SSL and StartTLS can't be used at the same time.
 		if srv.SSL && srv.StartTLS {
 			warning := fmt.Errorf(
 				"%w: service '%s' can't set both SSL and StartTLS, StartTLS will be used",
-				config.ErrInvalidValue, srv.ServiceType,
+				config.ErrInvalidValue, srv.Type,
 			)
 			warnings.Append(warning)
 
@@ -198,7 +198,7 @@ func validateServices(services []config.Service) (map[NameInstance]config.Servic
 		default:
 			warning := fmt.Errorf(
 				"%w: service '%s' has an unsupported stats protocol: '%s'",
-				config.ErrInvalidValue, srv.ServiceType, srv.StatsProtocol,
+				config.ErrInvalidValue, srv.Type, srv.StatsProtocol,
 			)
 			warnings.Append(warning)
 
@@ -209,15 +209,15 @@ func validateServices(services []config.Service) (map[NameInstance]config.Servic
 
 		// Check for duplicated overrides.
 		key := NameInstance{
-			Name:     srv.ServiceType,
-			Instance: srv.ServiceInstance,
+			Name:     srv.Type,
+			Instance: srv.Instance,
 		}
 
 		if _, ok := serviceMap[key]; ok {
-			warning := fmt.Sprintf("a service override is duplicated for '%s'", srv.ServiceType)
+			warning := fmt.Sprintf("a service override is duplicated for '%s'", srv.Type)
 
-			if srv.ServiceInstance != "" {
-				warning = fmt.Sprintf("%s on instance '%s'", warning, srv.ServiceInstance)
+			if srv.Instance != "" {
+				warning = fmt.Sprintf("%s on instance '%s'", warning, srv.Instance)
 			}
 
 			warnings.Append(fmt.Errorf("%w: %s", config.ErrInvalidValue, warning))
@@ -558,8 +558,8 @@ func copyAndMergeServiceWithOverride(servicesMap map[NameInstance]Service, overr
 
 	for _, v := range overrides {
 		key := NameInstance{
-			Name:     v.ServiceType,
-			Instance: v.ServiceInstance,
+			Name:     v.Type,
+			Instance: v.Instance,
 		}
 		service := serviceMapWithOverride[key]
 
@@ -593,8 +593,8 @@ func applyOverrideInPlace(
 	for _, serviceKey := range serviceKeys {
 		service := servicesMap[serviceKey]
 
-		if service.Name != service.Config.ServiceType && service.Config.ServiceType != "" {
-			service.Name = service.Config.ServiceType
+		if service.Name != service.Config.Type && service.Config.Type != "" {
+			service.Name = service.Config.Type
 			service.ServiceType = ""
 		}
 
@@ -605,8 +605,8 @@ func applyOverrideInPlace(
 				service.ServiceType = CustomService
 			}
 
-			if service.Config.ServiceInstance != "" {
-				service.Instance = service.Config.ServiceInstance
+			if service.Config.Instance != "" {
+				service.Instance = service.Config.Instance
 			}
 
 			service.Active = true