Properties on Instances
Instances are available under server through the instance property
server/instanceAll instances have the following properties:
| Name | Description | Return type | Typical values |
|---|---|---|---|
| adminartifact | All management based artifact that are compatible with this instance | List of Entities | |
| alerting | If alerting is currently active on this instance | String | YES, NO |
| alertingpause | The list of defined alerting pauses for this instance | List of Entities | |
| classification | Instance classification | Entity | dataguard,standby |
| connected | Value indicating if dbWatch currently has a valid connection to this instance | String | true, false |
| databasetype | The database type of the instance | String | oracle, sqlserver, … |
| defaultdriver | The default jdbc driver for this instance | Entity | com.microsoft.sqlserver:mssql-jdbc:13.2.1.jre11 |
| displayname | The given name of the instance as an Entity | Entity | My Dev Instance |
| driver | The jdbc driver that is used to connect to this instance | Entity | com.microsoft.sqlserver:mssql-jdbc:13.2.1.jre11 |
| engine | The name of the database/schema, if any, where the dbwatch engine framework is stored | String | dbwatch |
| enginetype | The engine types defined for this instance (currently sql and ssh) | List of String | sql, ssh |
| engineuser | The user dbWatch uses (if any) to connect to this instance to run engine procedures. | String | dbwatch |
| flush | Flushes the cache (on the dbWatch Server) for this instance | String | Flushed instance |
| group | The group this instance is a part of | String | Development, Production, … |
| hasengine | YES/NO value indicating if this instance has a dbwatch engine framework. | String | YES/NO |
| hasnote | If this instance has a note | Boolean | true, false |
| host | The hostip/name that was supplied when registering this instance | String | 10.0.0.83, localhost, .. |
| hostip | The IP address of this instance | String | 10.0.0.46 |
| hostname | The host name of this instance, fallback to host if the name is not resolvable | String | test1.mydomain.com |
| installable | A list of all jobs (engine and non engine) that are compatible with this instance | List of Entities | Transactions load, instance_connection_alert, … |
| installableproperty | A list of all no engine jobs that are compatible with this instance | List of Entities | instance_connection_alert, instance_restart_alert |
| installabletask | A list of all engine jobs that are compatible with this instance | List of Entities | Transaction log size check, Transactions load, … |
| log | Log entries for this instance | The server log and connector log entries for this instance | |
| monauthtest | Performs a test connection to the instance using the defined monitoring engine authentication (if any) | String | OK, No Auth, Connection to 10.0.1.192:5432 refused. Check that the hostname and port are correct and that the postmaster is accepting TCP/IP connections. |
| monitoring | If this instance has a monitoring engine | String | YES, NO |
| name | The given name of the instance | String | My Dev Instance |
| networktest | Tries to categorize connection issues to this instance | Entity | unknownHost, Ok |
| offlinetask | A list of all task that was installed on the instance the last time it was connected | List of Entities | |
| pause | If job execution on this instance is permitted | String | YES, NO |
| pollingpause | List of defined polling pauses for this instance | List of String | 1782376147000=>1h |
| port | The port dbWatch uses to connect to this instance | Number | 1433, 1521, 3306, … |
| propauthtest | Performs a test connection to the instance using the defined property authentication | String | OK, No Auth, Connection to 10.0.1.192:5432 refused. Check that the hostname and port are correct and that the postmaster is accepting TCP/IP connections. |
| propuser | The user dbWatch uses to connect to this instance to resolve dynamic properties. | String | sa, sys |
| servicegrouping | The service grouping(s) (if any) that this instance belongs to | List of Entity | |
| sessionqueue | The number of engine jobs waiting to be executed on this instance | Number | 0 |
| sid | The SID for this instance (only relevant for Oracle) | String | ORCL |
| status | The current status for this instance | Entity | OK, ALARM, WARNING, LOST CONNECTION, … |
| statusnumber | The current status for this instance as a number | Number | 1, 2, 4, … |
| statustime | The time that the instance got its current status, as milliseconds since 1970 | Number | 1696935522503 |
| subgroup | The sugroup this instance is a part of (if any) | String | Project A |
| task | A list of all the dbWatch jobs that are installed on this instance | List of Entities | Query cache hitrate, Thread cache hitrate, … |
| unacknowledged | Value indicating if this instance has jobs with unacknowledged warning/alarms | String | true, false |
In addition, there are platform-specific properties for each database type
Properties for MS SQLServer
Properties for Oracle
Properties for PostgreSQL
Properties for MySQL
Properties for Sybase
Properties for MongoDB