https://github.com/ixpantia/googleErrorReportingR
R wrapper for the Google Cloud Platform Error Reporting API
https://github.com/ixpantia/googleErrorReportingR
gcp gcp-error-reporting googlecloudplatform hacktoberfest
Last synced: 14 days ago
JSON representation
R wrapper for the Google Cloud Platform Error Reporting API
- Host: GitHub
- URL: https://github.com/ixpantia/googleErrorReportingR
- Owner: ixpantia
- License: other
- Created: 2022-06-17T22:10:35.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T22:13:10.000Z (6 months ago)
- Last Synced: 2025-03-01T12:46:05.722Z (about 2 months ago)
- Topics: gcp, gcp-error-reporting, googlecloudplatform, hacktoberfest
- Language: R
- Homepage: https://ixpantia.github.io/googleErrorReportingR
- Size: 486 KB
- Stars: 6
- Watchers: 1
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - ixpantia/googleErrorReportingR - R wrapper for the Google Cloud Platform Error Reporting API (R)
README
---
output: github_document
editor_options:
chunk_output_type: console
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%"
)
library(jsonlite)
library(lubridate)
```
# 
[](https://cran.r-project.org/package=googleErrorReportingR)
# googleErrorReportingR
This is an R wrapper for the Google Cloud Platform Error Reporting API. It uses
the Error Reporting API as defined in the [projects.events.report](https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.events/report)
method.
## Installation
You can install the development version of googleErrorReportingR from
[GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("ixpantia/googleErrorReportingR")
```
## Usage
Before you start, please set up a file called `.Renviron` that contains the
following line.
```
PROJECT_ID=
ERROR_REPORTING_API_KEY=
```
If you are running a session, then restart your R session so that the
environmental variables are read.
You can pass on the `project_id` and `api_key` to the function call directly,
but since we typically use this many time in one code-base we default to the
values in the environmental variables so that instead of:
```{r, eval= FALSE}
report_error(message, project_id, api_key)
```
We can call
```{r, eval= FALSE}
report_error(message)
```
and put the effort in defining the error message at each location in the code
that we want to monitor.
the following is a basic example of usage:
```{r example}
library(googleErrorReportingR)
message <- format_error_message()
message$serviceContext$service <- "A demo service"
message$serviceContext$version <- "v0.3.4"
googleErrorReportingR::report_error(message)
```
If your project-id and api_key are set up correctly the message above will
appear in the Google Error Reporting UI as follows:
## Adding details
Note that the message we are sending, once we convert the list to the json body
as required by the API, contains all the information elements that we can add to
the message.
```{r}
toJSON(message, auto_unbox = TRUE, pretty = TRUE )
```
Please read the vignette for further details on how to configure each and
everyone of them.
## Roadmap
We are working on the next version of `googleErrorReportingR` to include the use
of the `list` endpoint.