org.spf4j.perf.aspects.FileMonitorAspect Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spf4j-aspects Show documentation
spf4j aspects for monitoring performance and retry
There is a newer version: 8.10.0
/*
 * Copyright (c) 2001-2017, Zoltan Farkas All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Additionally licensed with:
 *
 * 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 org.spf4j.perf.aspects;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.InputStream;
import java.io.OutputStream;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.spf4j.perf.MeasurementRecorderSource;
import org.spf4j.perf.impl.RecorderFactory;
import org.spf4j.perf.io.MeasuredInputStream;
import org.spf4j.perf.io.MeasuredOutputStream;

/**
 * Aspect that intercepts File Read and File Write.
 * @author zoly
 */
@Aspect
@SuppressFBWarnings("PRMC_POSSIBLY_REDUNDANT_METHOD_CALLS")
public final class FileMonitorAspect {

    public static final int SAMPLE_TIME = Integer.getInteger("spf4j.perf.file.sampleTimeMillis", 300000);

    public static final boolean ADD_FILE_DETAIL = Boolean.getBoolean("spf4j.perf.file.addFileDetail");

    private static final MeasurementRecorderSource RECORDER_READ =
            RecorderFactory.createScalableCountingRecorderSource("file-read", "bytes",
            SAMPLE_TIME);
    private static final MeasurementRecorderSource RECORDER_WRITE =
            RecorderFactory.createScalableCountingRecorderSource("file-write", "bytes",
            SAMPLE_TIME);

    @Around("call(long java.nio.channels.FileChannel.read(..))")
    public Object nioReadLong(final ProceedingJoinPoint pjp) throws Throwable {
        Long result = (Long) pjp.proceed();
        if (result >= 0) {
            RECORDER_READ.getRecorder(pjp.getSourceLocation().getWithinType()).record(result);
        }
        return result;
    }

    @Around("call(int java.nio.channels.FileChannel.read(..))")
    public Object nioReadInt(final ProceedingJoinPoint pjp) throws Throwable {
        Integer result = (Integer) pjp.proceed();
        if (result >= 0) {
            RECORDER_READ.getRecorder(pjp.getSourceLocation().getWithinType()).record(result);
        }
        return result;
    }

    @Around("call(long java.nio.channels.FileChannel.write(..))")
    public Object nioWriteLong(final ProceedingJoinPoint pjp) throws Throwable {
        Long result = (Long) pjp.proceed();
        if (result >= 0) {
            RECORDER_WRITE.getRecorder(pjp.getSourceLocation().getWithinType()).record(result);
        }
        return result;
    }

    @Around("call(int java.nio.channels.FileChannel.write(..))")
    public Object nioWriteInt(final ProceedingJoinPoint pjp) throws Throwable {
        Integer result = (Integer) pjp.proceed();
        RECORDER_WRITE.getRecorder(pjp.getSourceLocation().getWithinType()).record(result);
        return result;
    }

    @SuppressFBWarnings("ISB_TOSTRING_APPENDING")
    private static String getLogInfo(final ProceedingJoinPoint pjp) {
      String logInfo = pjp.getSourceLocation().getWithinType().getName();
      if (ADD_FILE_DETAIL) {
        logInfo += ':' + pjp.getArgs()[0].toString();
      }
      return logInfo;
    }

    @Around("call(java.io.FileInputStream.new(java.io.File))")
    public Object fileIS(final ProceedingJoinPoint pjp) throws Throwable {
      return new MeasuredInputStream((InputStream) pjp.proceed(), getLogInfo(pjp), RECORDER_READ);
    }

    @Around("call(java.io.InputStream java.nio.file.Files.newInputStream(..))")
    public Object filesIS(final ProceedingJoinPoint pjp) throws Throwable {
      return new MeasuredInputStream((InputStream) pjp.proceed(), getLogInfo(pjp), RECORDER_READ);
    }

    @Around("call(java.io.FileOutputStream.new(java.io.File))")
    public Object fileOS(final ProceedingJoinPoint pjp) throws Throwable {
        return new MeasuredOutputStream((OutputStream) pjp.proceed(), getLogInfo(pjp), RECORDER_WRITE);
    }

    @Around("call(java.io.OutputStream java.nio.file.Files.newOutputStream(..))")
    public Object filesOS(final ProceedingJoinPoint pjp) throws Throwable {
        return new MeasuredOutputStream((OutputStream) pjp.proceed(), getLogInfo(pjp), RECORDER_WRITE);
    }

}