MSSQL Metadatas (windows.plugin) (#19147)
* add_mssql_metadata: Add first part of MSSQL metdata * add_mssql_metadata: Add MSSQL instances * add_mssql_metadata: Add MSSQL databases * fix and reorder --------- Co-authored-by: ilyam8 <ilya@netdata.cloud>
thiagoftsm committed
Dec 7, 2024 at 15:21 UTC
b42facc8de2bf793e0c9930ba907b6cfcd6df07b
1 file changed
+265
src/collectors/windows.plugin/metadata.yaml
+265
@@ -812,3 +812,268 @@ modules:
812
chart_type: line
813
dimensions:
814
- name: purged
815
+ - meta:
816
+ plugin_name: windows.plugin
817
+ module_name: PerflibMSSQL
818
+ monitored_instance:
819
+ name: MS SQL Server
820
+ link: "https://www.microsoft.com/en-us/sql-server/"
821
+ categories:
822
+ - data-collection.windows-systems
823
+ icon_filename: "windows.svg"
824
+ related_resources:
825
+ integrations:
826
+ list: []
827
+ info_provided_to_referring_integrations:
828
+ description: ""
829
+ keywords:
830
+ - windows
831
+ - microsoft
832
+ - sql
833
+ - queries
834
+ most_popular: false
835
+ overview:
836
+ data_collection:
837
+ metrics_description: |
838
+ This collector monitors Microsoft SQL Server statistics.
839
+ method_description: |
840
+ It queries different SQL objects per instance from Perflib in order to gather the metrics.
841
+ supported_platforms:
842
+ include: ["windows"]
843
+ exclude: []
844
+ multi_instance: false
845
+ additional_permissions:
846
+ description: ""
847
+ default_behavior:
848
+ auto_detection:
849
+ description: |
850
+ The collector automatically detects all of the metrics, no further configuration is required.
851
+ limits:
852
+ description: ""
853
+ performance_impact:
854
+ description: ""
855
+ setup:
856
+ prerequisites:
857
+ list: []
858
+ configuration:
859
+ file:
860
+ name: "netdata.conf"
861
+ section_name: "[plugin:windows]"
862
+ description: "The Netdata main configuration file"
863
+ options:
864
+ description: ""
865
+ folding:
866
+ title: "Config option"
867
+ enabled: false
868
+ list:
869
+ - name: PerflibMSSQL
870
+ description: An option to enable or disable the data collection.
871
+ default_value: yes
872
+ required: false
873
+ examples:
874
+ folding:
875
+ enabled: true
876
+ title: ""
877
+ list: []
878
+ troubleshooting:
879
+ problems:
880
+ list: []
881
+ alerts: []
882
+ metrics:
883
+ folding:
884
+ title: Metrics
885
+ enabled: false
886
+ description: ""
887
+ availability: []
888
+ scopes:
889
+ - name: MSSQL instance
890
+ description: "These metrics refer to the Microsoft SQL Servers instances defined on host."
891
+ labels:
892
+ - name: mssql_instance
893
+ description: The instance name.
894
+ metrics:
895
+ - name: mssql.instance_user_connections
896
+ description: User connections
897
+ unit: connections
898
+ chart_type: line
899
+ dimensions:
900
+ - name: user
901
+ - name: mssql.instance_sqlstats_batch_requests
902
+ description: Total of batches requests
903
+ unit: requests/s
904
+ chart_type: line
905
+ dimensions:
906
+ - name: batch
907
+ - name: mssql.instance_sql_errors
908
+ description: Errors
909
+ unit: errors/s
910
+ chart_type: line
911
+ dimensions:
912
+ - name: errors
913
+ - name: mssql.instance_sqlstats_sql_compilations
914
+ description: SQL compilations
915
+ unit: compilations/s
916
+ chart_type: line
917
+ dimensions:
918
+ - name: compilations
919
+ - name: mssql.instance_sqlstats_sql_recompilations
920
+ description: SQL re-compilations
921
+ unit: recompiles/s
922
+ chart_type: line
923
+ dimensions:
924
+ - name: recompiles
925
+ - name: mssql.instance_sqlstats_auto_parameterization_attempts
926
+ description: Failed auto-parameterization attempts
927
+ unit: attempts/s
928
+ chart_type: line
929
+ dimensions:
930
+ - name: failed
931
+ - name: mssql.instance_sqlstats_safe_auto_parameterization_attempts
932
+ description: Safe auto-parameterization attempts
933
+ unit: attempts/s
934
+ chart_type: line
935
+ dimensions:
936
+ - name: safe
937
+ - name: mssql.instance_accessmethods_page_splits
938
+ description: Pages splits
939
+ unit: splits/s
940
+ chart_type: line
941
+ dimensions:
942
+ - name: page
943
+ - name: mssql.instance_cache_hit_ratio
944
+ description: Buffer Cache hit ratio
945
+ unit: percentage
946
+ chart_type: line
947
+ dimensions:
948
+ - name: hit_ratio
949
+ - name: mssql.instance_bufman_iops
950
+ description: Number of pages input and output
951
+ unit: pages/s
952
+ chart_type: line
953
+ dimensions:
954
+ - name: read
955
+ - name: written
956
+ - name: mssql.instance_bufman_checkpoint_pages
957
+ description: Flushed pages
958
+ unit: pages/s
959
+ chart_type: line
960
+ dimensions:
961
+ - name: log
962
+ - name: mssql.instance_bufman_page_life_expectancy
963
+ description: Page life expectancy
964
+ unit: seconds
965
+ chart_type: line
966
+ dimensions:
967
+ - name: life_expectancy
968
+ - name: mssql.instance_memmgr_server_memory
969
+ description: Memory committed
970
+ unit: bytes
971
+ chart_type: line
972
+ dimensions:
973
+ - name: memory
974
+ - name: mssql.instance_memmgr_connection_memory_bytes
975
+ description: Amount of dynamic memory to maintain connections
976
+ unit: bytes
977
+ chart_type: line
978
+ dimensions:
979
+ - name: memory
980
+ - name: mssql.instance_memmgr_pending_memory_grants
981
+ description: Process waiting for memory grant
982
+ unit: processes
983
+ chart_type: line
984
+ dimensions:
985
+ - name: pending
986
+ - name: mssql.instance_memmgr_external_benefit_of_memory
987
+ description: Performance benefit from adding memory to a specific cache
988
+ unit: bytes
989
+ chart_type: line
990
+ dimensions:
991
+ - name: benefit
992
+ - name: mssql.instance_locks_deadlocks
993
+ description: Lock requests that resulted in deadlock
994
+ unit: deadlocks/s
995
+ chart_type: line
996
+ dimensions:
997
+ - name: alloc_unit
998
+ - name: application
999
+ - name: database
1000
+ - name: extent
1001
+ - name: file
1002
+ - name: hobt
1003
+ - name: key
1004
+ - name: metadata
1005
+ - name: oib
1006
+ - name: object
1007
+ - name: page
1008
+ - name: rid
1009
+ - name: row_group
1010
+ - name: xact
1011
+ - name: mssql.instance_locks_lock_wait
1012
+ description: Lock requests that required the caller to wait
1013
+ unit: locks/s
1014
+ chart_type: line
1015
+ dimensions:
1016
+ - name: alloc_unit
1017
+ - name: application
1018
+ - name: database
1019
+ - name: extent
1020
+ - name: file
1021
+ - name: hobt
1022
+ - name: key
1023
+ - name: metadata
1024
+ - name: oib
1025
+ - name: object
1026
+ - name: page
1027
+ - name: rid
1028
+ - name: row_group
1029
+ - name: xact
1030
+ - name: mssql.instance_blocked_processes
1031
+ description: Blocked processes
1032
+ unit: processes
1033
+ chart_type: line
1034
+ dimensions:
1035
+ - name: blocked
1036
+ - name: Database
1037
+ description: "These metrics refer to Microsoft SQL Server databases."
1038
+ labels:
1039
+ - name: mssql_instance
1040
+ description: The instance name.
1041
+ - name: database
1042
+ description: The database name.
1043
+ metrics:
1044
+ - name: mssql.database_active_transactions
1045
+ description: Active transactions per database
1046
+ unit: transactions
1047
+ chart_type: line
1048
+ dimensions:
1049
+ - name: active
1050
+ - name: mssql.database_transactions
1051
+ description: Transactions
1052
+ unit: transactions/s
1053
+ chart_type: line
1054
+ dimensions:
1055
+ - name: transactions
1056
+ - name: mssql.database_write_transactions
1057
+ description: Write transactions
1058
+ unit: transactions/s
1059
+ chart_type: line
1060
+ dimensions:
1061
+ - name: write
1062
+ - name: mssql.database_backup_restore_operations
1063
+ description: Backup IO per database
1064
+ unit: operations/s
1065
+ chart_type: line
1066
+ dimensions:
1067
+ - name: backup
1068
+ - name: mssql.database_log_flushes
1069
+ description: Log flushes
1070
+ unit: flushes/s
1071
+ chart_type: line
1072
+ dimensions:
1073
+ - name: log
1074
+ - name: mssql.database_log_flushed
1075
+ description: Log flushed
1076
+ unit: bytes/s
1077
+ chart_type: line
1078
+ dimensions:
1079
+ - name: flushed