Categorygithub.com/intelsdi-x/snap-plugin-collector-osv
repositorypackage
0.0.0-20221107230939-4e9b0e412b7f
Repository: https://github.com/intelsdi-x/snap-plugin-collector-osv.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

DISCONTINUATION OF PROJECT.

This project will no longer be maintained by Intel.

This project has been identified as having known security escapes.

Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.

Intel no longer accepts patches to this project.

DISCONTINUATION OF PROJECT

This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.

Build Status Go Report Card

snap collector plugin - osv

  1. Getting Started
  1. Documentation
  1. Community Support
  2. Contributing
  3. License
  4. Acknowledgements

Getting Started

System Requirements

OSv host with rest api support. For dev builds please run OSv with external network support

sudo ./scripts/run.py -n -v --api

Compile plugin

make

Documentation

Examples

Example of running snap osv collector and writing data to file.

Ensure snap daemon is running:

  • initd: sudo service snap-telemetry start
  • systemd: sudo systemctl start snap-telemetry
  • command line: sudo snapteld -l 1 -t 0 &

Download and load snap plugins:

$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-collector-osv/latest/linux/x86_64/snap-plugin-collector-osv
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/linux/x86_64/snap-plugin-publisher-file
$ snaptel plugin load snap-plugin-collector-osv
$ snaptel plugin load snap-plugin-publisher-file

See available metrics for your system

$ snaptel metric list

Create a task JSON file:

{
   "version":1,
   "schedule":{
      "type":"simple",
      "interval":"1s"
   },
   "workflow":{
      "collect":{
         "metrics":{
            "/intel/osv/trace/wait/waitqueue_wake_one":{},
            "/intel/osv/trace/callout/callout_reset":{},
            "/intel/osv/cpu/cputime":{},
            "/intel/osv/memory/free":{}
         },
         "config":{
            "/intel/osv":{
               "swagIP":"192.168.122.89",
               "swagPort":8000
            }
         },
         "process":null,
         "publish":[
            {
               "plugin_name":"file",
               "config":{
                  "file":"/tmp/published_osv.log"
               }
            }
         ]
      }
   }
}

Alternatively use provided example manifest:

Change ip address and port of osv host in task manifest:

vim example/osv-file-example.json

Create task:

$ snaptel task create -t example/osv-file-example.json
Using task manifest to create task
Task created
ID: 02dd7ff4-8106-47e9-8b86-70067cd0a850
Name: Task-02dd7ff4-8106-47e9-8b86-70067cd0a850
State: Running

See file output (this is just part of the file):

NOTE file publisher now outputs json format; this is output from older version of that plugin

NAMESPACEDATATIMESTAMPSOURCE
/intel/osv/cpu/cputime1765213052015-11-25 15:36:04.225846442 +0000 UTC192.168.122.89
/intel/osv/memory/free20234035202015-11-25 15:36:04.226192641 +0000 UTC192.168.122.89
/intel/osv/trace/callout/callout_reset2062172015-11-25 15:36:04.226534352 +0000 UTC192.168.122.89
/intel/osv/trace/wait/waitqueue_wake_one13199422015-11-25 15:36:04.226810341 +0000 UTC192.168.122.89

Collected Metrics

This plugin has the ability to gather the following metrics:

NamespaceData TypeDescription
/intel/osv/cpu/cputimeuint64cputime
/intel/osv/memory/freeuint64free memory
/intel/osv/memory/totaluint64total memory
/intel/osv/trace/virtio/virtio_wait_for_queueuint64
/intel/osv/trace/virtio/virtio_enable_interruptsuint64
/intel/osv/trace/virtio/virtio_disable_interruptsuint64
/intel/osv/trace/virtio/virtio_kicked_event_idxuint64
/intel/osv/trace/virtio/virtio_add_bufuint64
/intel/osv/trace/virtio/virtio_net_rx_packetuint64
/intel/osv/trace/virtio/virtio_net_rx_wakeuint64
/intel/osv/trace/virtio/virtio_net_fill_rx_ringuint64
/intel/osv/trace/virtio/virtio_net_fill_rx_ring_addeduint64
/intel/osv/trace/virtio/virtio_net_tx_packetuint64
/intel/osv/trace/virtio/virtio_net_tx_failed_add_bufuint64
/intel/osv/trace/virtio/virtio_net_tx_no_space_calling_gcuint64
/intel/osv/trace/virtio/virtio_net_tx_packet_sizeuint64
/intel/osv/trace/virtio/virtio_net_tx_xmit_one_failed_to_postuint64
/intel/osv/trace/virtio/virtio_blk_read_config_capacityuint64
/intel/osv/trace/virtio/virtio_blk_read_config_size_maxuint64
/intel/osv/trace/virtio/virtio_blk_read_config_seg_maxuint64
/intel/osv/trace/virtio/virtio_blk_read_config_geometryuint64
/intel/osv/trace/virtio/virtio_blk_read_config_blk_sizuint64
/intel/osv/trace/virtio/virtio_blk_read_config_topologyuint64
/intel/osv/trace/virtio/virtio_blk_read_config_wceuint64
/intel/osv/trace/virtio/virtio_blk_read_config_rouint64
/intel/osv/trace/virtio/virtio_blk_make_request_seg_maxuint64
/intel/osv/trace/virtio/virtio_blk_make_request_readonlyuint64
/intel/osv/trace/virtio/virtio_blk_wakeuint64
/intel/osv/trace/virtio/virtio_blk_strategyuint64
/intel/osv/trace/virtio/virtio_blk_req_okuint64
/intel/osv/trace/virtio/virtio_blk_req_unsuppuint64
/intel/osv/trace/virtio/virtio_blk_req_erruint64
/intel/osv/trace/net/net_packet_inuint64
/intel/osv/trace/net/net_packet_outuint64
/intel/osv/trace/net/net_packet_handlinguint64
/intel/osv/trace/tcp/tcp_stateuint64
/intel/osv/trace/tcp/tcp_input_ackuint64
/intel/osv/trace/tcp/tcp_outputuint64
/intel/osv/trace/tcp/tcp_output_erroruint64
/intel/osv/trace/tcp/tcp_output_resched_startuint64
/intel/osv/trace/tcp/tcp_output_resched_enduint64
/intel/osv/trace/tcp/tcp_output_startuint64
/intel/osv/trace/tcp/tcp_output_retuint64
/intel/osv/trace/tcp/tcp_output_just_retuint64
/intel/osv/trace/tcp/tcp_output_cant_take_inp_lockuint64
/intel/osv/trace/tcp/tcp_timer_tso_flushuint64
/intel/osv/trace/tcp/tcp_timer_tso_flush_retuint64
/intel/osv/trace/tcp/tcp_timer_tso_flush_erruint64
/intel/osv/trace/memory/memory_mallocuint64
/intel/osv/trace/memory/memory_malloc_mempooluint64
/intel/osv/trace/memory/memory_malloc_largeuint64
/intel/osv/trace/memory/memory_malloc_pageuint64
/intel/osv/trace/memory/memory_freeuint64
/intel/osv/trace/memory/memory_reallocuint64
/intel/osv/trace/memory/memory_page_allocuint64
/intel/osv/trace/memory/memory_page_freeuint64
/intel/osv/trace/memory/memory_huge_failureuint64
/intel/osv/trace/memory/memory_reclaimuint64
/intel/osv/trace/memory/memory_waituint64
/intel/osv/trace/memory/memory_mmapuint64
/intel/osv/trace/memory/memory_mmap_erruint64
/intel/osv/trace/memory/memory_mmap_retuint64
/intel/osv/trace/memory/memory_munmapuint64
/intel/osv/trace/memory/memory_munmap_erruint64
/intel/osv/trace/memory/memory_munmap_retuint64
/intel/osv/trace/callout/callout_inituint64
/intel/osv/trace/callout/callout_resetuint64
/intel/osv/trace/callout/callout_stop_waituint64
/intel/osv/trace/callout/callout_stopuint64
/intel/osv/trace/callout/callout_thread_waitinguint64
/intel/osv/trace/callout/callout_thread_dispatchinguint64
/intel/osv/trace/wait/waitqueue_waituint64
/intel/osv/trace/wait/waitqueue_wake_oneuint64
/intel/osv/trace/wait/waitqueue_wake_alluint64
/intel/osv/trace/anync/async_timer_task_createuint64
/intel/osv/trace/anync/async_timer_task_destroyuint64
/intel/osv/trace/anync/async_timer_task_rescheduleuint64
/intel/osv/trace/anync/async_timer_task_canceluint64
/intel/osv/trace/anync/async_timer_task_shutdownuint64
/intel/osv/trace/anync/async_timer_task_fireuint64
/intel/osv/trace/anync/async_timer_task_misfireuint64
/intel/osv/trace/anync/async_timer_task_insertuint64
/intel/osv/trace/anync/async_timer_task_removeuint64
/intel/osv/trace/anync/async_worker_starteduint64
/intel/osv/trace/anync/async_worker_timer_fireuint64
/intel/osv/trace/anync/async_worker_timer_fire_retuint64
/intel/osv/trace/anync/async_worker_fireuint64
/intel/osv/trace/anync/async_worker_fire_retuint64
/intel/osv/trace/vfs/vfs_openuint64
/intel/osv/trace/vfs/vfs_open_retuint64
/intel/osv/trace/vfs/vfs_open_erruint64
/intel/osv/trace/vfs/vfs_closeuint64
/intel/osv/trace/vfs/vfs_close_retuint64
/intel/osv/trace/vfs/vfs_close_erruint64
/intel/osv/trace/vfs/vfs_mknoduint64
/intel/osv/trace/vfs/vfs_mknod_retuint64
/intel/osv/trace/vfs/vfs_mknod_erruint64
/intel/osv/trace/vfs/vfs_lseekuint64
/intel/osv/trace/vfs/vfs_lseek_retuint64
/intel/osv/trace/vfs/vfs_lseek_erruint64
/intel/osv/trace/vfs/vfs_preaduint64
/intel/osv/trace/vfs/vfs_pread_retuint64
/intel/osv/trace/vfs/vfs_pread_erruint64
/intel/osv/trace/vfs/vfs_pwriteuint64
/intel/osv/trace/vfs/vfs_pwrite_retuint64
/intel/osv/trace/vfs/vfs_pwrite_erruint64
/intel/osv/trace/vfs/vfs_pwritevuint64
/intel/osv/trace/vfs/vfs_pwritev_retuint64
/intel/osv/trace/vfs/vfs_pwritev_erruint64
/intel/osv/trace/vfs/vfs_ioctluint64
/intel/osv/trace/vfs/vfs_ioctl_retuint64
/intel/osv/trace/vfs/vfs_ioctl_erruint64
/intel/osv/trace/vfs/vfs_fsyncuint64
/intel/osv/trace/vfs/vfs_fsync_retuint64
/intel/osv/trace/vfs/vfs_fsync_erruint64
/intel/osv/trace/vfs/vfs_fstatuint64
/intel/osv/trace/vfs/vfs_fstat_retuint64
/intel/osv/trace/vfs/vfs_fstat_erruint64
/intel/osv/trace/vfs/vfs_readdiruint64
/intel/osv/trace/vfs/vfs_readdir_retuint64
/intel/osv/trace/vfs/vfs_readdir_erruint64
/intel/osv/trace/vfs/vfs_mkdiruint64
/intel/osv/trace/vfs/vfs_mkdir_retuint64
/intel/osv/trace/vfs/vfs_mkdir_erruint64
/intel/osv/trace/vfs/vfs_rmdiruint64
/intel/osv/trace/vfs/vfs_rmdir_retuint64
/intel/osv/trace/vfs/vfs_rmdir_erruint64
/intel/osv/trace/vfs/vfs_renameuint64
/intel/osv/trace/vfs/vfs_rename_retuint64
/intel/osv/trace/vfs/vfs_rename_erruint64
/intel/osv/trace/vfs/vfs_chdiruint64
/intel/osv/trace/vfs/vfs_chdir_retuint64
/intel/osv/trace/vfs/vfs_fchdiruint64
/intel/osv/trace/vfs/vfs_fchdir_retuint64
/intel/osv/trace/vfs/vfs_fchdir_erruint64
/intel/osv/trace/vfs/vfs_linkuint64
/intel/osv/trace/vfs/vfs_link_retuint64
/intel/osv/trace/vfs/vfs_link_erruint64
/intel/osv/trace/vfs/vfs_symlinkuint64
/intel/osv/trace/vfs/vfs_symlink_retuint64
/intel/osv/trace/vfs/vfs_symlink_erruint64
/intel/osv/trace/vfs/vfs_unlinkuint64
/intel/osv/trace/vfs/vfs_unlink_retuint64
/intel/osv/trace/vfs/vfs_unlink_erruint64
/intel/osv/trace/vfs/vfs_statuint64
/intel/osv/trace/vfs/vfs_stat_retuint64
/intel/osv/trace/vfs/vfs_stat_erruint64
/intel/osv/trace/vfs/vfs_lstatuint64
/intel/osv/trace/vfs/vfs_lstat_retuint64
/intel/osv/trace/vfs/vfs_lstat_erruint64
/intel/osv/trace/vfs/vfs_statfsuint64
/intel/osv/trace/vfs/vfs_statfs_retuint64
/intel/osv/trace/vfs/vfs_statfs_erruint64
/intel/osv/trace/vfs/vfs_fstatfsuint64
/intel/osv/trace/vfs/vfs_fstatfs_retuint64
/intel/osv/trace/vfs/vfs_fstatfs_erruint64
/intel/osv/trace/vfs/vfs_getcwduint64
/intel/osv/trace/vfs/vfs_getcwd_retuint64
/intel/osv/trace/vfs/vfs_getcwd_erruint64
/intel/osv/trace/vfs/vfs_dupuint64
/intel/osv/trace/vfs/vfs_dup_retuint64
/intel/osv/trace/vfs/vfs_dup_erruint64
/intel/osv/trace/vfs/vfs_dup3uint64
/intel/osv/trace/vfs/vfs_dup3_retuint64
/intel/osv/trace/vfs/vfs_dup3_erruint64
/intel/osv/trace/vfs/vfs_fcntluint64
/intel/osv/trace/vfs/vfs_fcntl_retuint64
/intel/osv/trace/vfs/vfs_fcntl_erruint64
/intel/osv/trace/vfs/vfs_accessuint64
/intel/osv/trace/vfs/vfs_access_retuint64
/intel/osv/trace/vfs/vfs_access_erruint64
/intel/osv/trace/vfs/vfs_isattyuint64
/intel/osv/trace/vfs/vfs_isatty_retuint64
/intel/osv/trace/vfs/vfs_isatty_erruint64
/intel/osv/trace/vfs/vfs_truncateuint64
/intel/osv/trace/vfs/vfs_truncate_retuint64
/intel/osv/trace/vfs/vfs_truncate_erruint64
/intel/osv/trace/vfs/vfs_ftruncateuint64
/intel/osv/trace/vfs/vfs_ftruncate_retuint64
/intel/osv/trace/vfs/vfs_ftruncate_erruint64
/intel/osv/trace/vfs/vfs_fallocateuint64
/intel/osv/trace/vfs/vfs_fallocate_retuint64
/intel/osv/trace/vfs/vfs_fallocate_erruint64
/intel/osv/trace/vfs/vfs_utimesuint64
/intel/osv/trace/vfs/vfs_utimes_retuint64
/intel/osv/trace/vfs/vfs_utimes_erruint64
/intel/osv/trace/vfs/vfs_utimensatuint64
/intel/osv/trace/vfs/vfs_utimensat_retuint64
/intel/osv/trace/vfs/vfs_utimensat_erruint64
/intel/osv/trace/vfs/vfs_futimensuint64
/intel/osv/trace/vfs/vfs_futimens_retuint64
/intel/osv/trace/vfs/vfs_futimens_erruint64
/intel/osv/trace/vfs/vfs_chmoduint64
/intel/osv/trace/vfs/vfs_chmod_retuint64
/intel/osv/trace/vfs/vfs_chmod_erruint64
/intel/osv/trace/vfs/vfs_fchmoduint64
/intel/osv/trace/vfs/vfs_fchmod_retuint64
/intel/osv/trace/vfs/vfs_fchownuint64
/intel/osv/trace/vfs/vfs_fchown_retuint64

Roadmap

As we launch this plugin, we do not have any outstanding requirements for the next release. If you have a feature request, please add it as an issue.

If you have a feature request, please add it as an issue and/or submit a pull request.

Community Support

This repository is one of many plugins in snap, a powerful telemetry framework. See the full project at http://github.com/intelsdi-x/snap To reach out to other users, head to the main framework

Contributing

We love contributions!

There's more than one way to give back, from examples to blogs to code updates. See our recommended process in CONTRIBUTING.md.

License

snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.

Acknowledgements

This is Open Source software released under the Apache 2.0 License. Please see the LICENSE file for full license details.

This software has been contributed by MIKELANGELO, a Horizon 2020 project co-funded by the European Union. https://www.mikelangelo-project.eu/

Thank You

And thank you! Your contribution, through code and participation, is incredibly important to us.