README
¶
Testing locally
Use either Tunnelmole, an open source tunneling tool, or ngrok, a popular closed source tunnelling tool, to start your local server.
With Tunnelmole
Install Tunnelmole with one of the following options:
- NPM:
npm install -g tunnelmole - Linux:
curl -s https://tunnelmole.com/sh/install-linux.sh | sudo bash - Mac:
curl -s https://tunnelmole.com/sh/install-mac.sh --output install-mac.sh && sudo bash install-mac.sh - Windows: Install with NPM, or if you don't have NodeJS installed, download the
exefile for Windows here and put it somewhere in your PATH.
Then, start Tunnelmole using:
tmole 8082
Grab the generated URL. For example:
https://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:8082
With ngrok
Start ngrok:
ngrok http https://localhost:8082
Grab the generated URL. For example:
https://c0fd-75-166-97-48.ngrok-free.app
Modifications
Modify the projectID check in vercel.HandleLog
- projectVerboseID := r.Header.Get(LogDrainProjectHeader)
- projectID, err := model2.FromVerboseID(projectVerboseID)
- if err != nil {
- log.WithContext(r.Context()).WithError(err).WithField("projectVerboseID", projectVerboseID).Error("failed to parse highlight project id from vercel request")
- http.Error(w, err.Error(), http.StatusBadRequest)
- return
- }
+ // projectVerboseID := r.Header.Get(LogDrainProjectHeader)
+ // projectID, err := model2.FromVerboseID(projectVerboseID)
+ // if err != nil {
+ // log.WithContext(r.Context()).WithError(err).WithField("projectVerboseID", projectVerboseID).Error("failed to parse highlight project id from
vercel request")
+ // http.Error(w, err.Error(), http.StatusBadRequest)
+ // return
+ // }
+ projectID := 3
Setting up logs
Set up a log drain using the following config
Click "Test Log Drain"
Wait about a minute for the logs to go through the OTEL pipeline
Observe logs in app with the start date set to 2022 (Vercel hardcodes the timestamp to something really old using Test Log Drain)
Documentation
¶
Index ¶
- Constants
- Variables
- func CreateLogDrain(ctx context.Context, vercelTeamID *string, vercelProjectIDs []string, ...) error
- func GetProjects(accessToken string, teamId *string) ([]*privateModel.VercelProject, error)
- func HandleLog(w http.ResponseWriter, r *http.Request)
- func Listen(r *chi.Mux, t trace.Tracer)
- func RemoveConfiguration(configId string, accessToken string, teamId *string) error
- func RemoveLogDrain(logDrainId string, accessToken string, teamId *string) error
- func RemoveLogDrains(ctx context.Context, vercelTeamID *string, accessToken string) error
- func SetEnvVariable(projectId string, apiKey string, accessToken string, teamId *string, ...) error
- type VercelAccessTokenResponse
Constants ¶
const ( SourcemapEnvKey = "HIGHLIGHT_SOURCEMAP_UPLOAD_API_KEY" ProjectIdEnvVar = "NEXT_PUBLIC_HIGHLIGHT_PROJECT_ID" )
Variables ¶
var ( VercelClientId = os.Getenv("VERCEL_CLIENT_ID") VercelClientSecret = os.Getenv("VERCEL_CLIENT_SECRET") ApiBaseUrl = "https://api.vercel.com" )
Functions ¶
func CreateLogDrain ¶
func GetProjects ¶
func GetProjects(accessToken string, teamId *string) ([]*privateModel.VercelProject, error)
func RemoveConfiguration ¶
func RemoveLogDrain ¶
func RemoveLogDrains ¶
Types ¶
type VercelAccessTokenResponse ¶
type VercelAccessTokenResponse struct {
AccessToken string `json:"access_token"`
TeamID *string `json:"team_id"`
}
func GetAccessToken ¶
func GetAccessToken(code string) (VercelAccessTokenResponse, error)
Source Files