mongodb_plugin: python README update
Ilya committed
Feb 27, 2017 at 17:27 UTC
5e644492edc2b3ac3d6077fb22ef8dc94ffd92d8
1 file changed
+143
python.d/README.md
+143
@@ -710,6 +710,149 @@ If no configuration is given, module will attempt to connect to memcached instan
710
711
---
712
713
+# mongodb
714
+
715
+Module monitor mongodb performance and health metrics
716
+
717
+**Requirements:**
718
+ * `python-pymongo` package.
719
+
720
+You need to install it manually.
721
+
722
+
723
+Number of charts depends on mongodb version, storage engine and other features (replication):
724
+
725
+1. **Read requests**:
726
+ * query
727
+ * getmore (operation the cursor executes to get additional data from query)
728
+
729
+2. **Write requests**:
730
+ * insert
731
+ * delete
732
+ * update
733
+
734
+3. **Active clients**:
735
+ * readers (number of clients with read operations in progress or queued)
736
+ * writers (number of clients with write operations in progress or queued)
737
+
738
+4. **Journal transactions**:
739
+ * commits (count of transactions that have been written to the journal)
740
+
741
+5. **Data written to the journal**:
742
+ * volume (volume of data)
743
+
744
+6. **Background flush** (MMAPv1):
745
+ * average ms (average time taken by flushes to execute)
746
+ * last ms (time taken by the last flush)
747
+
748
+8. **Read tickets** (WiredTiger):
749
+ * in use (number of read tickets in use)
750
+ * available (number of available read tickets remaining)
751
+
752
+9. **Write tickets** (WiredTiger):
753
+ * in use (number of write tickets in use)
754
+ * available (number of available write tickets remaining)
755
+
756
+10. **Cursors**:
757
+ * opened (number of cursors currently opened by MongoDB for clients)
758
+ * timedOut (number of cursors that have timed)
759
+ * noTimeout (number of open cursors with timeout disabled)
760
+
761
+11. **Connections**:
762
+ * connected (number of clients currently connected to the database server)
763
+ * unused (number of unused connections available for new clients)
764
+
765
+12. **Memory usage metrics**:
766
+ * virtual
767
+ * resident (amount of memory used by the database process)
768
+ * mapped
769
+ * non mapped
770
+
771
+13. **Page faults**:
772
+ * page faults (number of times MongoDB had to request from disk)
773
+
774
+14. **Cache metrics** (WiredTiger):
775
+ * percentage of bytes currently in the cache (amount of space taken by cached data)
776
+ * percantage of tracked dirty bytes in the cache (amount of space taken by dirty data)
777
+
778
+15. **Pages evicted from cache** (WiredTiger):
779
+ * modified
780
+ * unmodified
781
+
782
+16. **Queued requests**:
783
+ * readers (number of read request currently queued)
784
+ * writers (number of write request currently queued)
785
+
786
+17. **Errors**:
787
+ * msg (number of message assertions raised)
788
+ * warning (number of warning assertions raised)
789
+ * regular (number of regular assertions raised)
790
+ * user (number of assertions corresponding to errors generated by users)
791
+
792
+18. **Storage metrics** (one chart for every database)
793
+ * dataSize (size of all documents + padding in the database)
794
+ * indexSize (size of all indexes in the database)
795
+ * storageSize (size of all extents in the database)
796
+
797
+19. **Documents in the database** (one chart for all databases)
798
+ * documents (number of objects in the database among all the collections)
799
+
800
+20. **tcmalloc metrics**
801
+ * central cache free
802
+ * current total thread cache
803
+ * pageheap free
804
+ * pageheap unmapped
805
+ * thread cache free
806
+ * transfer cache free
807
+ * heap size
808
+
809
+21. **Commands total/failed rate**
810
+ * count
811
+ * createIndex
812
+ * delete
813
+ * eval
814
+ * findAndModify
815
+ * insert
816
+
817
+22. **Locks metrics** (acquireCount metrics - number of times the lock was acquired in the specified mode)
818
+ * Global lock
819
+ * Database lock
820
+ * Collection lock
821
+ * Metadata lock
822
+ * oplog lock
823
+
824
+23. **Replica set members state**
825
+ * state
826
+
827
+24. **Oplog window**
828
+ * window (interval of time between the oldest and the latest entries in the oplog)
829
+
830
+25. **Replication lag**
831
+ * member (time when last entry from the oplog was applied for every member)
832
+
833
+26. **Replication set member heartbeat latency**
834
+ * member (time when last heartbeat was received from replica set member)
835
+
836
+
837
+### configuration
838
+
839
+Sample:
840
+
841
+```yaml
842
+local:
843
+ name : 'local'
844
+ host : '127.0.0.1'
845
+ port : 27017
846
+ user : 'netdata'
847
+ pass : 'netdata'
848
+
849
+```
850
+
851
+If no configuration is given, module will attempt to connect to mongodb daemon on `127.0.0.1:27017` address
852
+
853
+---
854
+
855
+
856
# mysql
857
858
Module monitors one or more mysql servers