[{"_1":2,"_179":-5,"_180":-5},"loaderData",{"_3":4,"_13":14,"_19":20,"_157":158},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17},"username","isAskGordonEnabled",true,"isUsingNewTemplate","routes/_layout.r.$namespace.$reponame",{"_21":22,"_23":-5,"_24":11,"_25":11,"_26":27,"_28":29,"_30":-5,"_31":11,"_32":33,"_86":87,"_111":112,"_150":-5,"_151":11,"_152":11,"_153":11,"_154":-5,"_155":156},"canonicalUrl","https://hub.docker.com/r/solarwinds/fluentd-papertrail/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","solarwinds","reponame","fluentd-papertrail","cloudBuildSource","isAutobuildsAvailable","repo",{"_34":35,"_41":42,"_44":45,"_46":47,"_48":11,"_49":50,"_51":52,"_53":54,"_37":29,"_26":27,"_56":57,"_58":43,"_59":60,"_61":60,"_62":63,"_64":-5,"_65":66,"_67":68,"_69":11,"_70":27,"_71":72,"_77":11,"_78":79,"_83":27,"_84":85},"categories",[36],{"_37":38,"_39":40},"name","Monitoring & observability","slug","monitoring-and-observability","content_types",[43],"image","date_registered","2019-09-30T20:43:37.470776Z","description","A Fluentd container image with support for sending logs to Papertrail.","is_private","last_updated","2023-10-31T12:47:38.973688Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[55],"application/vnd.docker.container.image.v1+json","pull_count",6643762,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","# Fluent::Plugin::Papertrail\n\n[![Gem Version](https://badge.fury.io/rb/fluent-plugin-papertrail.svg)](https://badge.fury.io/rb/fluent-plugin-papertrail) [![CircleCI](https://circleci.com/gh/solarwinds/fluent-plugin-papertrail/tree/master.svg?style=shield)](https://circleci.com/gh/solarwinds/fluent-plugin-papertrail/tree/master)\n\n## Description\n\nThis repository contains the Fluentd Papertrail Output Plugin.\n\n## Installation\n\nInstall this gem when setting up fluentd:\n```ruby\ngem install fluent-plugin-papertrail\n```\n\n## Usage\n\n### Setup\n\nThis plugin connects to Papertrail log destinations over TCP+TLS. This connection method should be enabled by default in standard Papertrail accounts, see:\n```\npapertrailapp.com > Settings > Log Destinations\n```\n\nTo configure this in fluentd:\n```xml\n\n type papertrail\n papertrail_host \n papertrail_port \n\n```\n\n### Configuring a record_transformer\n\nThis plugin expects the following fields to be set for each Fluent record:\n```\n message The log\n program The program/tag\n severity A valid syslog severity label\n facility A valid syslog facility label\n hostname The source hostname for papertrail logging\n```\n\nThe following example is a `record_transformer` filter, from the Kubernetes assets [in the Solarwinds fluentd-deployment repo](https://github.com/solarwinds/fluentd-deployment/blob/master/docker/conf/kubernetes.conf), that is used along with the [fluent-plugin-kubernetes_metadata_filter](https://github.com/fabric8io/fluent-plugin-kubernetes_metadata_filter) to populate the required fields for our plugin:\n```yaml\n\n type kubernetes_metadata\n\n\n\n type record_transformer\n enable_ruby true\n \n hostname ${record[\"kubernetes\"][\"namespace_name\"]}-${record[\"kubernetes\"][\"pod_name\"]}\n program ${record[\"kubernetes\"][\"container_name\"]}\n severity info\n facility local0\n message ${record['log']}\n \n\n```\n\nIf you don't set `hostname` and `program` values in your record, they will default to the environment variable `FLUENT_HOSTNAME` or `'unidentified'` and the fluent tag, respectively.\n\n### Advanced Configuration\nThis plugin inherits a few useful config parameters from Fluent's `BufferedOutput` class.\n\nParameters for flushing the buffer, based on size and time, are `buffer_chunk_limit` and `flush_interval`, respectively. This plugin overrides the inherited default `flush_interval` to `1`, causing the fluent buffer to flush to Papertrail every second. \n\nIf the plugin fails to write to Papertrail for any reason, the log message will be put back in Fluent's buffer and retried. Retrying can be tuned and inherits a default configuration where `retry_wait` is set to `1` second and `retry_limit` is set to `17` attempts.\n\nIf you want to change any of these parameters simply add them to a match stanza. For example, to flush the buffer every 60 seconds and stop retrying after 2 attempts, set something like:\n```xml\n\n type papertrail\n papertrail_host \n papertrail_port \n flush_interval 60\n retry_limit 2\n\n```\n\n## Kubernetes Annotations\n\nIf you're running this plugin in Kubernetes with the kubernetes_metadata_filter plugin enabled you can redirect logs to alternate Papertrail destinations by adding annotations to your Pods or Namespaces:\n\n```\nsolarwinds.io/papertrail_host: 'logs0.papertrailapp.com'\nsolarwinds.io/papertrail_port: '12345'\n```\n\nIf both the Pod and Namespace have annotations for any running Pod, the Pod's annotation is used.\n\n## Development\n\nThis plugin is targeting Ruby 2.4 and Fluentd v1.0, although it should work with older versions of both.\n\nWe have a [Makefile](Makefile) to wrap common functions and make life easier.\n\n### Install Dependencies\n`make bundle`\n\n### Test\n`make test`\n\n### Release in [RubyGems](https://rubygems.org/gems/fluent-plugin-papertrail)\nTo release a new version, update the version number in the [GemSpec](fluent-plugin-papertrail.gemspec) and then, run:\n\n`make release`\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at: https://github.com/solarwinds/fluent-plugin-papertrail\n\n## License\n\nThe gem is available as open source under the terms of the [Apache License](LICENSE).\n\n# Questions/Comments?\n\nPlease [open an issue](https://github.com/solarwinds/fluent-plugin-papertrail/issues/new), we'd love to hear from you.\n","has_starred","hub_user","immutable_tags_settings",{"_73":11,"_74":75},"enabled","rules",[76],".*","is_automated","permissions",{"_80":17,"_81":11,"_82":11},"read","write","admin","user","storage_size",74378339,"orgData",{"_88":89,"_90":91,"_92":93,"_94":27,"_95":96,"_97":98,"_99":96,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":17},"id","c45c2ac5fb9c4204a092a025c52731b3","uuid","c45c2ac5-fb9c-4204-a092-a025c52731b3","type","organization","orgname","full_name","SolarWinds","location","Austin, TX","company","profile_url","https://www.solarwinds.com/","date_joined","2015-09-14T01:19:19Z","gravatar_url","https://www.gravatar.com/avatar/4eceff3718b5804c6e575fd1471cbb67?s=80&r=g&d=mm","gravatar_email","","badge","verified_publisher","is_active","recentTags",[113],{"_114":43,"_115":116,"_117":118,"_119":120,"_88":121,"_122":123,"_49":138,"_139":140,"_141":27,"_142":55,"_37":143,"_144":145,"_146":129,"_147":138,"_148":63,"_149":17},"content_type","creator",4134470,"digest","sha256:979a491cf204a3f59a77bb8676f1265e2079eec1e3a9ba96edc1331477a7adc2","full_size",25235870,537888424,"images",[124],{"_125":126,"_117":118,"_127":107,"_128":129,"_130":131,"_132":133,"_134":107,"_135":-5,"_136":120,"_61":63,"_137":-5},"architecture","amd64","features","last_pulled","2026-08-11T18:57:15.50236769Z","last_pushed","2023-10-31T12:47:39Z","os","linux","os_features","os_version","size","variant","2023-10-31T12:47:38.859514Z","last_updater",438212,"last_updater_username","media_type","latest","repository",7781945,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_32":159,"_167":168,"_155":177,"_178":11},{"_34":160,"_41":162,"_44":45,"_46":47,"_48":11,"_49":50,"_51":52,"_53":163,"_37":29,"_26":27,"_56":57,"_58":43,"_59":60,"_61":60,"_62":63,"_64":-5,"_65":66,"_67":68,"_69":11,"_70":27,"_71":164,"_77":11,"_78":166,"_83":27,"_84":85},[161],{"_37":38,"_39":40},[43],[55],{"_73":11,"_74":165},[76],{"_80":17,"_81":11,"_82":11},"tags",{"_169":60,"_170":-5,"_171":-5,"_172":173},"count","next","previous","results",[174],{"_114":43,"_115":116,"_117":118,"_119":120,"_88":121,"_122":175,"_49":138,"_139":140,"_141":27,"_142":55,"_37":143,"_144":145,"_146":129,"_147":138,"_148":63,"_149":17},[176],{"_125":126,"_117":118,"_127":107,"_128":129,"_130":131,"_132":133,"_134":107,"_135":-5,"_136":120,"_61":63,"_137":-5},[],"canDeleteTags","actionData","errors"]

Help

System theme

Docker Suite

solarwinds/fluentd-papertrail

Tags for solarwinds/fluentd-papertrail