mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-05 04:35:14 -05:00
## Description
This PR adds cloud logging admin source, tools, integration test and
docs.
1. Source is implemented in a manner consistent with the BigQuery
source. Supports ADC, OAuth and impersonate Service Account.
2. Total of 3 tools have been implemented
- `cloud-logging-admin-list-log-names`
- `cloud-logging-admin-list-resource-types`
- `cloud-logging-admin-query-logs`
3. docs added for resource and tools.
4. Supporting integration test is added with updated ci
Note for reviewers:
1. Integration test runs on cloud, will require `LOGADMIN_PROJECT` env
variable, the test creates logs in the project using the `logging`
client and then verifies working of the tools using the `logadmin`
client.
2. Moved `cache.go` from the BigQuery source to `sources/cache.go` due
to shared utility.
Regarding Tools:
1. `cloud-logging-admin-list-log-names` uses `client.Logs()` instead of
`client.Entries()`, as the latter is resource heavy and the tradeoff was
not being able to apply any filters, tool has an optional parameter
`limit` which defaults to 200.
2. `cloud-logging-admin-list-resource-types` uses
`client.ResourceDescriptors(ctx)`, aim of the tool is to enable the
agent become aware of the the resources present and utilise this
information in writing filters.
3. `cloud-logging-admin-query-logs` tool enables search and read logs
from Google Cloud.
Parameters:
`filter` (optional): A text string to search for specific logs.
`newestFirst` (optional): A simple true/false switch for ordering.
`startTime ` (optional): The start date and time to search from (e.g.,
2025-12-09T00:00:00Z). Defaults to 30 days ago if not set.
`endTime` (optional): The end date and time to search up to. Defaults to
"now".
`verbose` (optional): If set to true, Shows all available details for
each log entry else shows only the main info (timestamp, message,
severity).
`limit` (optional): The maximum number of log entries to return (default
is 200).
Looking forward to the feedback here, as `verbose` is simply implemented
to save context tokens, any alternative suggestion here is also
welcomed.
Simple tools.yaml
```
sources:
my-logging-admin:
kind: cloud-logging-admin
project: <Add project>
useClientOAuth: false
tools:
list_resource_types:
kind: cloud-logging-admin-list-resource-types
source: my-logging-admin
description: List the types of resource that are indexed by Cloud Logging.
list_log_names:
kind: cloud-logging-admin-list-log-names
source: my-logging-admin
description: List log names matching a filter criteria.
query_logs:
kind: cloud-logging-admin-query-logs
source: my-logging-admin
description: query logs
```
## PR Checklist
- [x] Make sure you reviewed
[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] Make sure to open an issue as a
[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
before writing your code! That way we can discuss the change, evaluate
designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [ ] Make sure to add `!` if this involve a breaking change
🛠️ Fixes #1772
@anubhav756 @averikitsch Thanks for the guidance and feedback on the
implementation plan.
---------
Co-authored-by: Yuan Teoh <yuanteoh@google.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
126 lines
2.8 KiB
Go
126 lines
2.8 KiB
Go
// Copyright 2025 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
package sources
|
|
|
|
import (
|
|
"sync"
|
|
"time"
|
|
)
|
|
|
|
// Item holds the cached value and its expiration timestamp
|
|
type Item struct {
|
|
Value any
|
|
ExpiresAt int64 // Unix nano timestamp
|
|
}
|
|
|
|
// IsExpired checks if the item is expired
|
|
func (item Item) IsExpired() bool {
|
|
return time.Now().UnixNano() > item.ExpiresAt
|
|
}
|
|
|
|
// OnEvictFunc is the signature for the callback
|
|
type OnEvictFunc func(key string, value any)
|
|
|
|
// Cache is a thread-safe, expiring key-value store
|
|
type Cache struct {
|
|
mu sync.RWMutex
|
|
items map[string]Item
|
|
onEvict OnEvictFunc
|
|
}
|
|
|
|
// NewCache creates a new cache and cleans up every 55 min
|
|
func NewCache(onEvict OnEvictFunc) *Cache {
|
|
const cleanupInterval = 55 * time.Minute
|
|
|
|
c := &Cache{
|
|
items: make(map[string]Item),
|
|
onEvict: onEvict,
|
|
}
|
|
|
|
go c.startCleanup(cleanupInterval)
|
|
return c
|
|
}
|
|
|
|
// startCleanup runs a ticker to periodically delete expired items
|
|
func (c *Cache) startCleanup(interval time.Duration) {
|
|
ticker := time.NewTicker(interval)
|
|
defer ticker.Stop()
|
|
|
|
for range ticker.C {
|
|
c.DeleteExpired()
|
|
}
|
|
}
|
|
|
|
// delete is an internal helper that assumes the write lock is held
|
|
func (c *Cache) delete(key string, item Item) {
|
|
if c.onEvict != nil {
|
|
c.onEvict(key, item.Value)
|
|
}
|
|
delete(c.items, key)
|
|
}
|
|
|
|
// Set adds an item to the cache
|
|
func (c *Cache) Set(key string, value any) {
|
|
const ttl = 55 * time.Minute
|
|
expires := time.Now().Add(ttl).UnixNano()
|
|
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
|
|
// If item already exists, evict the old one before replacing
|
|
if oldItem, found := c.items[key]; found {
|
|
c.delete(key, oldItem)
|
|
}
|
|
|
|
c.items[key] = Item{
|
|
Value: value,
|
|
ExpiresAt: expires,
|
|
}
|
|
}
|
|
|
|
// Get retrieves an item from the cache
|
|
func (c *Cache) Get(key string) (any, bool) {
|
|
c.mu.RLock()
|
|
item, found := c.items[key]
|
|
if !found || item.IsExpired() {
|
|
c.mu.RUnlock()
|
|
return nil, false
|
|
}
|
|
c.mu.RUnlock()
|
|
|
|
return item.Value, true
|
|
}
|
|
|
|
// Delete manually evicts an item
|
|
func (c *Cache) Delete(key string) {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
|
|
if item, found := c.items[key]; found {
|
|
c.delete(key, item)
|
|
}
|
|
}
|
|
|
|
// DeleteExpired removes all expired items
|
|
func (c *Cache) DeleteExpired() {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
|
|
for key, item := range c.items {
|
|
if item.IsExpired() {
|
|
c.delete(key, item)
|
|
}
|
|
}
|
|
}
|