{"id":13761675,"url":"https://github.com/census-ecosystem/opencensus-ruby-exporter-stackdriver","last_synced_at":"2025-05-10T14:30:33.062Z","repository":{"id":29352791,"uuid":"118837254","full_name":"census-ecosystem/opencensus-ruby-exporter-stackdriver","owner":"census-ecosystem","description":"OpenCensus Ruby exporters for Google Stackdriver","archived":true,"fork":false,"pushed_at":"2023-05-02T19:08:20.000Z","size":81,"stargazers_count":9,"open_issues_count":3,"forks_count":11,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-27T08:04:45.927Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/census-ecosystem.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-01-24T23:53:57.000Z","updated_at":"2023-07-31T17:43:46.000Z","dependencies_parsed_at":"2023-07-14T19:12:23.173Z","dependency_job_id":null,"html_url":"https://github.com/census-ecosystem/opencensus-ruby-exporter-stackdriver","commit_stats":null,"previous_names":["census-instrumentation/ruby-stackdriver-exporter"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/census-ecosystem%2Fopencensus-ruby-exporter-stackdriver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/census-ecosystem%2Fopencensus-ruby-exporter-stackdriver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/census-ecosystem%2Fopencensus-ruby-exporter-stackdriver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/census-ecosystem%2Fopencensus-ruby-exporter-stackdriver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/census-ecosystem","download_url":"https://codeload.github.com/census-ecosystem/opencensus-ruby-exporter-stackdriver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253428173,"owners_count":21906863,"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":[],"created_at":"2024-08-03T14:00:21.992Z","updated_at":"2025-05-10T14:30:32.828Z","avatar_url":"https://github.com/census-ecosystem.png","language":"Ruby","funding_links":[],"categories":["Exporters"],"sub_categories":["Ruby"],"readme":"\u003e **Warning**\n\u003e\n\u003e OpenCensus and OpenTracing have merged to form [OpenTelemetry](https://opentelemetry.io), which serves as the next major version of OpenCensus and OpenTracing.\n\u003e\n\u003e OpenTelemetry has now reached feature parity with OpenCensus, with tracing and metrics SDKs available in .NET, Golang, Java, NodeJS, and Python. **All OpenCensus Github repositories, except [census-instrumentation/opencensus-python](https://github.com/census-instrumentation/opencensus-python), will be archived on July 31st, 2023**. We encourage users to migrate to OpenTelemetry by this date.\n\u003e\n\u003e To help you gradually migrate your instrumentation to OpenTelemetry, bridges are available in Java, Go, Python, and JS. [**Read the full blog post to learn more**](https://opentelemetry.io/blog/2023/sunsetting-opencensus/).\n\n# Ruby Stackdriver Exporter for OpenCensus\n\nThis repository contains the source to the `opencensus-stackdriver` gem. This\nlibrary is a plugin for\n[Ruby OpenCensus](https://github.com/census-instrumentation/opencensus-ruby)\nthat exports data to [Stackdriver](https://cloud.google.com/stackdriver/).\n\nOpenCensus is a platform- and provider-agnostic framework for distributed\ntracing and stats collection. For more information, see https://opencensus.io.\n\nThis library is in an alpha stage, and the API is subject to change. In\nparticular, support for the Stats API is currently incomplete and experimental.\n\n## Quick Start\n\n### Installation\n\nInstall the gem using Bundler:\n\n1. Add the `opencensus-stackdriver` gem to your application's Gemfile:\n\n```ruby\ngem \"opencensus-stackdriver\"\n```\n\n2. Use Bundler to install the gem:\n\n```sh\n$ bundle install\n```\n\nThe core `opencensus` gem and the `google-cloud-trace` client library for the\nStackdriver API will be installed automatically as dependencies.\n\n### Installing the plugin\n\nThe Stackdriver plugin can be installed using OpenCensus configuration.\nInsert the following code in your application's initialization:\n\n```ruby\nOpenCensus.configure do |c|\n  c.trace.exporter = OpenCensus::Trace::Exporters::Stackdriver.new\nend\n```\n\nIf you are using **Ruby on Rails**, you can equivalently include this code in\nyour Rails config:\n\n```ruby\nconfig.opencensus.trace.exporter = OpenCensus::Trace::Exporters::Stackdriver.new\n```\n\nSee the documentation for\n[OpenCensus::Trace::Exporters::Stackdriver](http://www.rubydoc.info/gems/opencensus-stackdriver/OpenCensus/Trace/Exporters/Stackdriver)\nfor information on the configuration options for the Stackdriver exporter.\n\nYou can find more general information on using OpenCensus from Ruby, including\nconfiguring automatic trace capture and adding custom spans, in the\n[core `opencensus` README](https://github.com/census-instrumentation/opencensus-ruby).\n\n### Connecting to Stackdriver\n\nIf you do not have a Google Cloud project, create one from the\n[cloud console](https://console.cloud.google.com/).\n\nThe Stackdriver plugin needs credentials for your project in order to export\ntraces to the Stackdriver backend. If your application is running in Google\nCloud Platform hosting (i.e.\n[Google App Engine](https://cloud.google.com/appengine/),\n[Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/), or\n[Google Compute Engine](https://cloud.google.com/compute/)), then the plugin\ncan generally retrieve the needed credentials automatically from the runtime\nenvironment. See\n[this section](https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-trace#running-on-google-cloud-platform)\nfrom the `google-cloud-trace` README for details.\n\nIf you are running the application locally, in self-hosted VMs, or a third\nparty hosting service, you will need to provide the project ID and credentials\n(keyfile) to the Google Cloud client library. See\n[this section](https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-trace#running-locally-and-elsewhere)\nfor details.\n\nEither way, once you have the Stackdriver exporter configured, you can view\ntraces on the [Google Cloud Console](https://console.cloud.google.com/traces).\n\n## About the library\n\n### Supported Ruby Versions\n\nThis library is supported on Ruby 2.2+.\n\nHowever, Ruby 2.3 or later is strongly recommended, as earlier releases have\nreached or are nearing end-of-life. After June 1, 2018, OpenCensus will provide\nofficial support only for Ruby versions that are considered current and\nsupported by Ruby Core (that is, Ruby versions that are either in normal\nmaintenance or in security maintenance).\nSee https://www.ruby-lang.org/en/downloads/branches/ for further details.\n\n### Versioning\n\nThis library follows [Semantic Versioning](http://semver.org/).\n\nIt is currently in major version zero (0.y.z), which means that anything may\nchange at any time, and the public API should not be considered stable.\n\n## Contributing\n\nContributions to this library are always welcome and highly encouraged.\n\nSee the [Contributing Guide](CONTRIBUTING.md) for more information on how to get\nstarted.\n\nPlease note that this project is released with a Contributor Code of Conduct. By\nparticipating in this project you agree to abide by its terms. See\n[Code of Conduct](CODE_OF_CONDUCT.md) for more information.\n\n## License\n\nThis library is licensed under Apache 2.0. Full license text is available in\n[LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcensus-ecosystem%2Fopencensus-ruby-exporter-stackdriver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcensus-ecosystem%2Fopencensus-ruby-exporter-stackdriver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcensus-ecosystem%2Fopencensus-ruby-exporter-stackdriver/lists"}