Usługa monitorowania dla wtyczek

// Creates the collector based on the given configuration values.
// @param config 
// @return uniqueId for this collector instance or null if the collector could not be created
String create(JSONObject config); 

// Returns the metadata for the available metrics from the collector.
// @param uniqueId of the collector instance to query
// @return {"categories":    [{"categoryType":"<ROLE_CATEGORY>"}],
updateInterval":  "<secs>":,"<ROLE_CATEGORY>": {<see
IMetricService.getServerMetadat{}>}}
JSONObject getMetadata(String uniqueId); 		 

// @param uniqueId of the collector instance to query 
// @param metricType not used in this release and defaults to "all" 
// @return {"<ROLE_CATEGORY>":[{"<METRIC_NAME>":"<METRIC_VALUE>"}, ...},
JSONObject getMetrics(String uniqueId);  

// @param uniqueId of the collector instance to shutdown void delete(String uniqueId);  
void delete(String uniqueId);

maestro.monitorAgent.register('{
  "version"  : Number,
  "node"     : String,
  "role"     : String,
  "collector": String,
  "config"   : JSONObject
}')

wersja

Numer wersji

węzeł

Nazwa serwera, na którym działa kolektor.

rola

Nazwa roli, dla której działa kolektor.

collector

Typ kolektora.

Konfiguracja

Wymagane i opcjonalne właściwości tworzenia instancji określonego typu kolektora dla konkretnego węzła i roli. Każdy typ kolektora ma własne właściwości konfiguracyjne.

maestro.monitorAgent.register('{
	"node":"${maestro.node}",
	"role":"${maestro.role}",
	"collector":"com.ibm.maestro.monitor.collector.script",
	"config":{<config properties>}')

• Wersja pliku metadanych.
• Tablica nazw kategorii do zarejestrowania (1..n).
• Przedział czasu (w sekundach), który ma być odpytywał o zaktualizowane dane.
• Parametry konfiguracyjne, które są unikalne dla każdej kategorii (na przykład: mbeanQuery).
• Lista obiektów metadanych metryki:

  attributeName

  Określa atrybut z kolektora, który ma zostać powiązany z tym pomiarem.

  metricName

  Określa nazwę pomiaru, która ma być ujawniona za pośrednictwem interfejsów API agenta monitorowania.

  metricType

  Określa typ danych, np. zakres, licznik, czas, średni, procent i łańcuch. metricType nie jest jeszcze sprawdzona. Wszystkie metricType znajdujące się na liście zostały zaakceptowane. Użytkownik może wybrać metricType , który najlepiej pasuje do danych z listy.

  opis

  (opcjonalne) Określa łańcuch, który definiuje pomiar.

{
"Version" : <metadata file version>,
"update_interval": <interval  time in seconds to poll for updated data>,
"Category": [
            <array of category names to register (1..n)>
            ],
"Metadata": [
            {
            "<category name from Category[]>":{
                "metrics": [
                  { 
                   "attribute_name": <attribute from collector to associate to this metric>
                   "metricsName": <metric name to expose through monitoring agent APIs>
                   "metricType": <metric value data type including "RANGE",
                                                                          "COUNTER",
                                                                          "PERCENT",
                                                                          "STRING", 
                                                                          "AVAILABILITY",
                                                                          STATUS>
									} ,
			           ... ...
                    ]
                  }
                },
              ... ...
             ]
}

{
"version": <version number>,
    "category": [
        <category name>,
	   ... ...
        
    ],
    "content": [
        {
            <category name> :{
                <metric name>: <metric value>,
                   ... ...
            }
        },
       ... ...
    ]
}

{
"version": 2,
    "category": [
        "WAS_JVMRuntime",
        "WAS_TransactionManager",
        "WAS_JDBCConnectionPools",
        "WAS_WebApplications"
    ],
    "content": [
        {
            "WAS_JVMRuntime": {
                "jvm_heap_used": 86.28658,
                "used_memory": 176576,
                "heap_size": 204639
            }
        },
        {
            "WAS_TransactionManager": {
                "rolledback_count": 0,
                "active_count": 0,
                "committed_count": 0
            }
        },
        {
            "WAS_JDBCConnectionPools": {
                "max_percent_used": 0,
                "min_percent_used": 0,
                "percent_used": 0,
                "wait_time": 0,
                "min_wait_time": 0,
                "max_wait_time": 0
            }
        },
        {
            "WAS_WebApplications": {
                "max_service_time": 210662,
                "min_service_time": 0,
                "service_time": 8924,
                "request_count": 30
            }
        }
    ]
}

• Na poziomie skryptu lub procedury obsługi danych, gdy błędy występują w skryptach i procedurach obsługi danych.
• Na poziomie kolektora, gdy błędy są zgłaszane, gdy kolektor uruchamia skrypt lub wywołuje procedurę obsługi danych.

{
"FFDC": <error message >
}

The collector has trouble in calling scripts registered by plug-in for outputting metrics, for example, script files are missing
The collector gets error return code (RC) when executing script files
The collector gets nothing and empty string from return of executing script files
The collector fails to parse metrics from return of executing script files due to unexpected ending or incorrect JSON format
The collector gets error message from return of executing script files
The collector executing script files is timeout

The collector waiting for  HTTP response is timeout
The collector gets nothing from HTTP response
The collector get error status code from HTTP response, such as 4xx for client error, 5xx for server error
The collector gets error from user transformer instead of metrics
The collector fails to parse metrics from user transformer  due to incorrect JSON format

[
{
    ... ...
        "category": "DATABASE_DRILLDOWN_HEALTH",
        "label": "Database Health Indicator",
        "displays": [
            {
                "label": " Database Health Indicator ",
                "chartWidgetName": "paas.widgets.HealthStatusTrend",                
                "metrics": [
                    {
                        "attributeName": "data_server_status",
                        "label": " Data_Server_Status " 
                    },
                    {
                        "attributeName": "io",
                        "label": "I/O" 
                    },
                    {
                        "attributeName": "locking",
                        "label": " Locking " 
                    },                                         
                    {
                        "attributeName": "logging",
                        "label": "Logging " 
                    },
                    {
                        "attributeName": "memory",
                        "label": "Memory" 
                    },      
                    {
                        "attributeName": "recovery",
                        "label": "Recovery" 
                    }, 
                    {
                        "attributeName": "sorting",
                        "label": "Sorting" 
                    }, 
                    {
                        "attributeName": "storage",
                        "label": "Storage" 
                    },                                                                            
                    {
                        "attributeName": "workload",
                        "label": "Workload" 
                    } 
                ]
            }                                     
        ] 
    }
]

• W NORMIE
• OSTRZEŻENIE
• KRYTYCZNY
• NIEZNANA

... ...
"metadata":[
    	{
            "DATABASE_AVAILABILITY":{
                "metrics":[{
                        "attribute_name":"database_availability",
                        "metric_name":"database_availability",
                        "metric_type":"AVAILABILITY"
                    }
                ]
            }
        },    
... ...

• Ze względu na to, że skrypty pobierają pomiary według własnego mechanizmu, mogą utworzyć predefiniowaną metrykę dla produktu availability , gdy nie powiedzie się pobranie pomiarów.
• Ponieważ procedury obsługi danych pobierają dane z modułu gromadzącego dane HTTP, moduł gromadzący dane musi je poinformować, gdy z odpowiedzi HTTP nie są pobierane żadne dane. W ramach umowy kolektor HTTP przekazuje obiekt o wartości NULL do procedur obsługi danych, gdy nie zostanie on w stanie uzyskać danych, zanim wywoła procedury obsługi danych. Procedury obsługi danych powinny tworzyć metrykę predefiniowaną dla produktu availability , gdy odbierają one obiekt o wartości NULL. Więcej informacji na ten temat zawiera sekcja Rozwiązywanie problemów z kolektorami monitorowania.

• Jeśli do wtyczki używana jest strategia skalowania, do określenia statusu poprawności używany jest stan skalowania. Po osiągnięciu progu wartość availability jest ustawiana na wartość "WARNING", dopóki nie zostanie utworzona nowa instancja roli. Jeśli zostanie osiągnięta maksymalna liczba instancji roli lub utworzona instancja nie powiedzie się, parametr availability zostanie ustawiony na wartość "CRITICAL".
• Jeśli strategia skalowania nie jest używana, charakterystyki systemu operacyjnego są używane w produkcie availability. Jeśli użycie procesora jest większe niż 70%, parametr availability jest ustawiony na wartość "OSTRZEŻENIE", a jeśli użycie jest większe niż 85% ", availability jest ustawiony na wartość" KRYTYCZNY ".

• Błędna nazwa roli w parametrze "register".

  Gdy wtyczka rejestruje kolektor dla siebie samego, zwykle uzyskuje on nazwę roli bezpośrednio z poziomu produktu maestro.role['name'] w swoich skryptach. Jednak gdy wtyczka rejestruje kolektor dla innych wtyczek, a nie sam siebie, zwracana jest niepoprawna nazwa roli. Na przykład, gdy wtyczka OPMDB2 rejestruje kolektor dla wtyczki DB2, produkt maestro.role['name'] zwraca niepoprawną nazwę roli, ponieważ zawsze zwraca nazwę roli bieżącej wtyczki. Upewnij się, że podano poprawną nazwę roli do parametru "register" i upewnij się, że jest on używany przez moduł gromadzący dane.

• Plik monitoring_ui.json w wersji 1 znajduje się w niepoprawnej wtyczce.

  Ponieważ plik monitoring_ui.json w wersji 1 nie zawiera informacji o roli, interfejs użytkownika przyjmuje, że produkt monitoring_ui.json obsługuje rolę wtyczki, w której znajduje się dany plik. Aby uniknąć tego problemu, upewnij się, że produkt monitoring_ui.json znajduje się we wtyczce, dla której gromadzone są pomiary, lub użyj pliku monitoring_ui.json w wersji 2, który jawnie definiuje role.

• Brak nazwy roli w pliku monitoring_ui.json w wersji 2.

  Plik monitoring_ui.json w wersji 2 wymaga atrybutu "displayRoles". Jeśli plik monitoring_ui.json w wersji 2 nie zawiera informacji o roli, interfejs użytkownika nie może znaleźć odpowiedniego monitoring_ui.json dla zgromadzonych wielkości mierzonych. Jeśli aktualizujesz monitoring_ui.json z wersji 1 do wersji 2, upewnij się, że zawiera ona atrybut "displayRoles" i uwzględni rolę, z jaką dany kolektor pracuje.

• Wielkości mierzone są gromadzone dla niewidocznej roli.

  Jeśli rola jest niewidoczna, wielkości mierzone nie są wyświetlane w interfejsie użytkownika, nawet jeśli są dla niego kolekcjonowane wielkości mierzone. Jeśli rola nie jest wyświetlana, upewnij się, że wartość "dashboard.visible" nie jest ustawiona na wartość false.

  Istnieją dwa rodzaje ról dla widoczności, widocznej roli i niewidocznej roli. Widoczna rola jest wyświetlana na stronie Virtual Application Instances (Instancje aplikacji wirtualnych) i zwykle są one wyświetlane w ramach wdrażania, takie jak WebSphere Application Server i role DB2® . Nie można wyświetlić niewidocznej roli na stronie Instancje aplikacji wirtualnej. Role te zwykle działają jako komponent zaplecza i asystenta. Przykłady: MONITORING, SSH i OPMDB2. Programiści wtyczek mogą określić widoczność swoich ról wtyczek, ustawiając wartość boolowskową dla atrybutu "dashboard.visible" w topologii. W poniższym fragmencie kodu topologii przedstawiono przykład:

  {    
  "vm-templates": [        
  	... ...
      {
              "name": "database-db2",
              "roles": [
                  {   
                      "type": "DB2",
                      "name": "DB2"     
                      ... ...  
                  },
                  {
                      "global": true,
                      "plugin": "ssh/2.0.0.1",
                      "dashboard.visible": false,
                      "type": "SSH",
                      "name": "SSH"
   
                 },
                  {
                      "global": true,
                      "plugin": "opmdb2/1.0.0.0",
                      "depends": [
                          {
                              "role": "database-db2.DB2",
                              "type": "DB2"
                          }
                      ],
                      "dashboard.visible": false,
                      "type": "OPMDB2",
                      "name": "OPMDB2"
                  },
                     ... ...
                 ],
                  ... ...
          }
      ],
  
  }

  W tym przykładzie baza danych DB2 jest rolą podstawową i jest widoczna. Protokoły SSH i OPMDB2 są niewidocznymi rolami, ponieważ ich wartość "dashboard.visible" jest ustawiona na false.
• Wielkości mierzone nie są gromadzone.

  Usługa monitorowania ignoruje role bez początkowych pomiarów nawet wtedy, gdy istnieje kolektor, który został pomyślnie zarejestrowany dla tej roli. Sprawdź pliki dziennika i śledzenia, aby sprawdzić, czy moduł gromadzący dane działa poprawnie.

• zdarzenie wyzwalające

  Działania skalowania są wyzwalane w oparciu o zmianę wartości określonych pomiarów. Zdarzenie wyzwalające określa typ wielkości mierzonych monitorowania i zakres progów, dla których wyzwalane są różne działania skalowania.

  Dla każdej wielkości mierzonej w definicji zdarzenia istnieją dwa progi: próg skali i próg skali. Na przykład użycie procesora dla maszyn wirtualnych, które uruchamiają instancje WebSphere Application Server , może być metryką dla zdarzenia wyzwalającego, a progi dla skali-in i scale-out-20% i 80%, a następnie, gdy wartość wykorzystania procesora jest wyższa niż 80%, nowy WebSphere Application Server instancja została uruchomiona. Jeśli użycie procesora jest mniejsze niż 20%, do usunięcia zostanie wybrana istniejąca instancja serwera WebSphere Application Server .

• Czas wyzwolenia

  Aby zapobiec występowaniu skoków, system korzysta z zakresu czasu w celu monitorowania wartości pomiaru, a nie wartości pobranej w chwili, zanim wyzwoli działanie skalowania. Czas wyzwalania określa czas, w którym ma być wstrzymany próg sprawdzający, zanim zostaną podjęte działania skalowania po spełnieniu warunku progu. Na przykład, w momencie, gdy wykorzystanie procesora jest monitorowane powyżej 80%, uruchamiany jest licznik czasu. Jeśli czas wyzwalacza jest ustawiony na 120 sekund, to gdy licznik czasu osiągnie wartość 120 sekund, operacja skalowania jest uruchamiana. Jeśli w czasie korzystania z procesora zostanie przekroczony limit czasu, co oznacza, że użycie procesora spada poniżej 80% w tym przykładzie, licznik czasu zostanie zatrzymany. Jest on restartowany, gdy użycie procesora ponownie zostanie wprowadzone do progu.

• Limit zasobów

  Aby zapobiec korzystaniu z wszystkich zasobów systemowych, wymagany jest limit zasobów dla zachowania skalowania. Na przykład: strategia skalowania powinna określać łączną liczbę instancji, które może mieć jednocześnie wtyczka lub co najmniej na podstawie skali lub skali. Jeśli wielkość klastra wtyczki osiągnie krawędź jego zakresów, żadna instancja nie zostanie dodana do klastra ani z niego usunięta, nawet jeśli zdarzenie wyzwalające jest spełnione.

"model": {
   "nodes": [
  	       {
			   ... ...
             },
             {
             "id": <policy id>
             "type":<policy type>
             "attributes": {
		
      	              <No.1 metric id for trigger event>: [
      	              < threshold for scale-in >,
      	              < threshold for scale-out >
      	               ],
      	              <No.2 metric for trigger event>: [
      	              < threshold for scale-in >,
      	              < threshold for scale-out >
      	               ],
      	              <... :[... ,... ]>
      	              <No.n metric for trigger event>: [
      	              < threshold for scale-in >,
      	              < threshold for scale-out >
      	                ],
      	              <trigger time id>: <trigger time value>
      	              <instance range number id": [
      	                 <min number>,
      	                 <max number>
      	                ],
					}
			},
			{
				... ...
			}
		]
}

"vm-templates": [
		{
			...
      scaling :{
                 "min": <number>,
                 "max": <number>,
                  }
		},
		{
      ...
		}
]

"vm-templates": [
{
	...
  scaling :{
     "role" : <role type for the template>,
     "triggerEvents": [
         {
            "metric": <metric category and item linked by ".">,
            "scaleOutThreshold": {
                "value": <metric value with its data type>,
                "type": "CONSTANT",
                "relation": <comparison symbol including "<", 
                                                         ">", 
                                                         "<=",
                                                         ">=" >
                             },
            "conjunction": <conjunction type with other trigger 
                           events including "OR", "AND">
            "scaleInThreshold": {
                "value": <number>,
                "type": "CONSTANT",
                "relation": <comparison symbol>
                         }
        	},
         "triggerTime": <number>
         },
        {
            "metric": " metric category and item",
            "scaleOutThreshold": {
                "value":<number>,
                "type": "CONSTANT",
                "relation": <comparison symbol>
            },
            "conjunction": <conjunction type with other trigger 
                           events>
            "scaleInThreshold": {
                "value": <number>,
                "type": "CONSTANT",
                "relation": <comparison symbol>,
                "electMetricTimeliness": <"historical"|"instant">
            }
            "triggerTime": <number>
        },
	  {
       {
            "metric": " metric category and item",
            "scaleUpCPUThreshold": {
                "value":<number>,
                "type": "CONSTANT",
                "relation": <comparison symbol>
            },
            "conjunction": <conjunction type with other trigger 
                           events>
            "triggerTime": <number>
	  },
	  {
            "metric": " metric category and item",
            "scaleUpMemoryThreshold": {
                "value":<number>,
                "type": "CONSTANT",
                "relation": <comparison symbol>
            },
            "conjunction": <conjunction type with other trigger 
                           events>
            "triggerTime": <number>
		  },
		  {
      ...
        }
    ],
    "min": <number>,
    "max": <number>,
    "maxcpucount": <number>,
    "minmemory": <number>,
    "cpucountUpIncrement": <number>,
    "memoryUpIncrement": <number>,
    "triggerTime": <number>,
   }
   ...
 },
 {
  ...
 }
]

1. Zakończona lub zakończona niepowodzeniem maszyna wirtualna, z wyjątkiem systemu głównego.
2. Maszyna wirtualna, która ma status inny niż RUNNING, taki jak URUCHAMIANIE, INICJOWANIE, URUCHAMIANIE, z wyjątkiem systemu głównego.
3. Maszyna wirtualna, której rola ma najmniejszą lub najmniejszą wartość określonej wielkości mierzonej między klastrem, z wyjątkiem systemu głównego.
4. Losowa maszyna wirtualna, z wyjątkiem systemu głównego.

{
    "role" : "WAS",
    "triggerEvents": [
        {
           "metric": "CPU.Used",
            "scaleOutThreshold": {
                "value": 80,
                "type": "CONSTANT",
                "relation": ">="
            },
            "conjunction": "OR",
            "scaleInThreshold": {
                "value": 20,
                "type": "CONSTANT",
                "relation": "<",
                "electMetricTimeliness" : "historical"
            }
        }
    ],
    "min": 1,
    "max": 10,
    "triggerTime": 120
}

"scaling": {
                   "role": "RTEMS"
                   "triggerEvents": [{
                          "metric": "RTEMS.ConnectionNumber ",
                          "scaleOutThreshold": { ... },
                          "conjunction": "OR",
                          "scaleInThreshold": {
                                    "value": 20,
                                    "type": "CONSTANT",
                                    "relation": "<",
                              "electMetricTimeliness" : "instant"
            }

             }
                       ],
                   "triggerTime": 120,
                   "min": 1,
                   "max": 10,
                   "manual": {
                             "scaleInMetric":"RTEMS.ConnectionNumber",
                             "metricType" : "instant",
                             "rule": "minimum"
                             }
                  }

• Jeśli stosowana jest strategia automatycznego skalowania, nie powinno być niczego innego, co jest wymagane w Budowniczym wzorcu w celu obsługi skalowania ręcznego. Wtyczka musi prezentować operacje skalowania ręcznego w operacjach skalowania ręcznego i ręcznie. Szablon skalowania udostępniony przez wtyczkę musi określać pomiar, który ma być używany do ręcznej skali-w przypadku użycia wielu pomiarów. Domyślnie używany jest tylko pierwszy pomiar. Typowe wtyczki obejmują serwer WebSphere Application Server i usługi współużytkowane, takie jak buforowanie i monitorowanie.
• Wtyczka powinna udostępniać kombinację automatycznych i ręcznych szablonów skalowania dla użytkownika, który ma zostać wybrany, ale tylko jeden z nich może być zastosowany do vmTemplate.
• Jeśli funkcja automatycznego skalowania we wtyczce nie ma być obsługiwana lub nie jest wymagana, ale należy włączyć skalowanie ręczne, należy zdefiniować zdarzenie triggerEvent. Szablon skalowania nadal udostępnia wartości min, max, role i triggerEvent. Jednak triggerEvent zawiera tylko wielkość mierzoną w skali, która ma być używana razem z atrybutami min i max (metrykami < lub >), które są przeznaczone dla dowolnej wtyczki lub usługi współużytkowanej do użycia, np. do systemu równoważenia obciążenia.

• Osiągnięto maksymalną liczbę instancji.
• Skalowanie zostało wstrzymane lub wyłączone
• Wdrażanie jest aktualizowane
• W chmurze nie ma wystarczających zasobów do zrealizowania żądania.

maestro.autoscalingAgent.scale_out('{
             "vmTemplate":  String, 
             "roleType":  String
         }') 

maestro.autoscalingAgent.scale_out('
 {"vmTemplate":"Web_Application-was", 
 		"roleType":"WAS"}
')

• Osiągnięto minimalną liczbę instancji.
• Skalowanie zostało wstrzymane lub wyłączone
• Wdrażanie jest aktualizowane

maestro.autoscalingAgent.scale_in('{
             "vmTemplate":  String, 
             "roleType":  String,
             ["node" : String]
         }')

• W modelu aplikacji nie podano strategii skalowania.
• Skalowanie zostało wstrzymane lub jest wyłączone
• Wdrażanie jest aktualizowane

maestro.autoscalingAgent.pause_autoscaling()

• W modelu aplikacji nie podano strategii skalowania.
• Skalowanie jest wznawiane lub jest wyłączone
• Wdrażanie jest aktualizowane

maestro.autoscalingAgent.resume_autoscaling()

• W modelu aplikacji nie podano strategii skalowania.
• Skalowanie jest już włączone
• Wdrażanie jest aktualizowane

maestro.autoscalingAgent.enable_autoscaling()

• W modelu aplikacji nie podano strategii skalowania.
• Skalowanie jest już wyłączone
• Wdrażanie jest aktualizowane

maestro.autoscalingAgent.disable_autoscaling()