googleErrorReportingR

R wrapper for the Google Cloud Platform Error Reporting API

https://github.com/ixpantia/googleerrorreportingr

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.0%) to scientific vocabulary

Keywords

gcp gcp-error-reporting googlecloudplatform hacktoberfest

Last synced: 9 months ago · JSON representation

Repository

R wrapper for the Google Cloud Platform Error Reporting API

Basic Info

Host: GitHub
Owner: ixpantia
License: other
Language: R
Default Branch: main
Homepage: https://ixpantia.github.io/googleErrorReportingR
Size: 486 KB

Statistics

Stars: 9
Watchers: 1
Forks: 4
Open Issues: 8
Releases: 2

Topics

gcp gcp-error-reporting googlecloudplatform hacktoberfest

Created about 4 years ago · Last pushed over 1 year ago

Metadata Files

Readme License

README.Rmd

---
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)
```



# 
[![CRAN status](https://www.r-pkg.org/badges/version/googleErrorReportingR)](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:

![Screenshot of the message as listed in the Google Error Reporting UI](man/figures/google_error_reporting_ui.png)

## 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.

Owner

Name: ixpantia
Login: ixpantia
Kind: organization
Location: Costa Rica

Website: https://www.ixpantia.com
Repositories: 10
Profile: https://github.com/ixpantia

GitHub Events

Total

Issues event: 2
Watch event: 5
Push event: 1
Pull request event: 1
Fork event: 1

Last Year

Issues event: 2
Watch event: 5
Push event: 1
Pull request event: 1
Fork event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 28
Total pull requests: 21
Average time to close issues: 17 days
Average time to close pull requests: 15 days
Total issue authors: 5
Total pull request authors: 3
Average comments per issue: 0.82
Average comments per pull request: 0.0
Merged pull requests: 20
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 2
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 2
Pull request authors: 0
Average comments per issue: 0.0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

FvD (17)
andreavargasmon (8)
telaroix (1)
andyquinterom (1)
mablan (1)

Pull Request Authors

FvD (16)
andreavargasmon (5)
telaroix (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 213 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 1
Total maintainers: 1

cran.r-project.org: googleErrorReportingR

Send Error Reports to the Google Error Reporting Service API

Homepage: https://github.com/ixpantia/googleErrorReportingR
Documentation: http://cran.r-project.org/web/packages/googleErrorReportingR/googleErrorReportingR.pdf
License: MIT + file LICENSE
Latest release: 0.0.4
published over 3 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 213 Last month

Rankings

Forks count: 14.9%

Dependent packages count: 29.8%

Stargazers count: 31.7%

Dependent repos count: 35.5%

Average: 37.3%

Downloads: 74.6%

Maintainers (1)

frans@ixpantia.com