{"id":18554232,"url":"https://github.com/oracle/fluent-plugin-oci-logging","last_synced_at":"2025-06-21T09:34:24.867Z","repository":{"id":39635616,"uuid":"379108540","full_name":"oracle/fluent-plugin-oci-logging","owner":"oracle","description":"This is the official fluentD output plugin for the Oracle Cloud Infrastructure (OCI) Logging service.","archived":false,"fork":false,"pushed_at":"2025-04-22T11:58:44.000Z","size":75,"stargazers_count":12,"open_issues_count":6,"forks_count":7,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-05-23T05:28:07.775Z","etag":null,"topics":["fluentd","fluentd-output-plugin","oci"],"latest_commit_sha":null,"homepage":"https://docs.cloud.oracle.com/en-us/iaas/Content/Logging/Concepts/loggingoverview.htm","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oracle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-06-22T01:34:22.000Z","updated_at":"2025-04-04T04:32:20.000Z","dependencies_parsed_at":"2024-10-31T15:27:44.719Z","dependency_job_id":"71778aeb-66a7-441b-9f44-55b1dd256818","html_url":"https://github.com/oracle/fluent-plugin-oci-logging","commit_stats":{"total_commits":10,"total_committers":4,"mean_commits":2.5,"dds":0.4,"last_synced_commit":"df0000f9c7373725fe04a861810b423ce312cfa2"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/oracle/fluent-plugin-oci-logging","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Ffluent-plugin-oci-logging","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Ffluent-plugin-oci-logging/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Ffluent-plugin-oci-logging/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Ffluent-plugin-oci-logging/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oracle","download_url":"https://codeload.github.com/oracle/fluent-plugin-oci-logging/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Ffluent-plugin-oci-logging/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261099910,"owners_count":23109635,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fluentd","fluentd-output-plugin","oci"],"created_at":"2024-11-06T21:20:25.411Z","updated_at":"2025-06-21T09:34:19.854Z","avatar_url":"https://github.com/oracle.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Oracle Cloud Infrastructure Fluentd Plugin\n\nThis is the official [fluentd](https://docs.fluentd.org/) plugin for the Oracle\nCloud Infrastructure (OCI) Logging service. This project is open source, in\nactive development and maintained by Oracle.\n\n## Requirements\nTo use this fluentd plugin, you must have:\n\n* An Oracle Cloud Infrastructure acount.\n* A user created in that account, in a group with a policy that grants the\ndesired permissions. This can be a user for yourself, or another person/system\nthat needs to call the API. For an example of how to set up a new user, group,\ncompartment, and policy, see [Adding Users](https://docs.cloud.oracle.com/Content/GSG/Tasks/addingusers.htm)\nin the Getting Started Guide. For a list of typical policies you may want to\nuse, see [Common Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/commonpolicies.htm)\nin the User Guide.\n* Ruby version 2.2 or later running on Mac, Linux or Windows.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'fluent-plugin-oci-logging'\n```\n\nAnd then execute:\n\n```shell\n$ bundle\n```\n\nOr install it yourself as:\n\n```\ngem install fluent-plugin-oci-logging\n```\n\nBesides the plugin, the above commands will also automatically install fluentd,\nas well as the rest of the required ruby dependencies, in your system.\n\n## Configuration\n\nFor usage with [instance principals](https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm):\n\n```xml\n\u003csource\u003e\n  @type dummy\n  tag test\n  dummy {\"test\":\"message\"}\n\u003c/source\u003e\n\u003cmatch **\u003e\n    @type oci_logging\n    log_object_id  ocid1.log.oc1.XXX.xxx\n\u003c/match\u003e\n```\n\nFor usage with an [API signing key]( https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm):\n\n```xml\n\u003csource\u003e\n  @type dummy\n  tag test\n  dummy {\"test\":\"message\"}\n\u003c/source\u003e\n\u003cmatch **\u003e\n    @type oci_logging\n    principal_override user\n    log_object_id  ocid1.log.oc1.XXX.xxx\n\u003c/match\u003e\n```\n\nTo authenticate as a particular user, you need to [generate an API Signing Key](https://docs.cloud.oracle.com/en-us/iaas/Content/API/SDKDocs/cliconfigure.htm) for that user.\n\n## Logging Setup\n\nDetailed instructions, alongside examples, on how you can setup your logging\nenvironment can be found in the official [OCI docs](https://docs.cloud.oracle.com/en-us/iaas/Content/Logging/Task/managinglogs.htm).\nAlso, to find out how to search your logs, you can check the documentation\nfor [log search](https://docs.cloud.oracle.com/en-us/iaas/Content/Logging/Concepts/searchinglogs.htm).\n\n## Documentation\n\nFull documentation, including prerequisites, installation, and configuration\ninstructions can be found [here](https://docs.cloud.oracle.com/en-us/iaas/Content/Logging/Concepts/loggingoverview.htm).\n\nAPI reference can be found [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby/latest/index.html).\n\nThis documentation can be found installed in your system in the gem specific directory. You can find its exact location by running the command:\n\n```shell\ngem contents fluent-plugin-oci-logging\n```\n\nAlternatively, you can also view it via ruby's documentation tool `ri` with the following command:\n\n```shell\nri -f markdown fluent-plugin-oci-logging:README\n```\n\nFinally, you can view it by extracting the gem contents (the gem file itself is a tar archive).\n\n\n## Known Issues\n\nYou can find information on any known issues with the SDK under the [Issues](https://github.com/oracle/fluent-plugin-oci-logging/issues) tab.\n\n## Questions or Feedback?\n\nPlease [open an issue for any problems or questions](https://github.com/oracle/fluent-plugin-oci-logging/issues) you may have.\n\nAddtional ways to get in touch:\n\n* [Stack Overflow](https://stackoverflow.com/): Please use the [oracle-cloud-infrastructure](https://stackoverflow.com/questions/tagged/oracle-cloud-infrastructure) and [oci-ruby-sdk](https://stackoverflow.com/questions/tagged/oci-ruby-sdk) tags in your post\n* [Developer Tools section](https://community.oracle.com/community/cloud_computing/bare-metal/content?filterID=contentstatus%5Bpublished%5D~category%5Bdeveloper-tools%5D\u0026filterID=contentstatus%5Bpublished%5D~objecttype~objecttype%5Bthread%5D) of the Oracle Cloud forums\n* [My Oracle Support](https://support.oracle.com)\n\n## Contributing\n\nThis project welcomes contributions from the community. Before submitting a pull\nrequest, please [review our contribution guide](./CONTRIBUTING.md).\n\n## Security\n\nPlease consult the [security guide](./SECURITY.md) for our responsible security\nvulnerability disclosure process.\n\n## License\n\nCopyright (c) 2021, Oracle and/or its affiliates.\n\nThis software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at \u003chttps://oss.oracle.com/licenses/upl\u003e\nor Apache License 2.0 as shown at \u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e. You may choose either license.\n\nSee [LICENSE](./LICENSE.txt) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Ffluent-plugin-oci-logging","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foracle%2Ffluent-plugin-oci-logging","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Ffluent-plugin-oci-logging/lists"}